From 422bc4db8e0ac603d433c0bfd03d0e64928e3bdc Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Tue, 10 Sep 2024 13:19:38 +0000 Subject: [PATCH] classref: Sync with current 3.x branch (de2f0f1) --- classes/class_@gdscript.rst | 16 +- classes/class_@globalscope.rst | 6 +- classes/class_aabb.rst | 4 +- classes/class_acceptdialog.rst | 4 +- classes/class_aescontext.rst | 4 +- classes/class_animatedsprite.rst | 4 +- classes/class_animatedsprite3d.rst | 4 +- classes/class_animatedtexture.rst | 4 +- classes/class_animation.rst | 4 +- classes/class_animationnode.rst | 4 +- classes/class_animationnodeadd2.rst | 4 +- classes/class_animationnodeadd3.rst | 4 +- classes/class_animationnodeanimation.rst | 4 +- classes/class_animationnodeblend2.rst | 4 +- classes/class_animationnodeblend3.rst | 4 +- classes/class_animationnodeblendspace1d.rst | 4 +- classes/class_animationnodeblendspace2d.rst | 4 +- classes/class_animationnodeblendtree.rst | 4 +- classes/class_animationnodeoneshot.rst | 4 +- classes/class_animationnodeoutput.rst | 4 +- classes/class_animationnodestatemachine.rst | 4 +- ...lass_animationnodestatemachineplayback.rst | 4 +- ...ss_animationnodestatemachinetransition.rst | 4 +- classes/class_animationnodetimescale.rst | 4 +- classes/class_animationnodetimeseek.rst | 4 +- classes/class_animationnodetransition.rst | 4 +- classes/class_animationplayer.rst | 4 +- classes/class_animationrootnode.rst | 4 +- classes/class_animationtrackeditplugin.rst | 4 +- classes/class_animationtree.rst | 4 +- classes/class_animationtreeplayer.rst | 4 +- classes/class_area.rst | 46 +- classes/class_area2d.rst | 44 +- classes/class_array.rst | 4 +- classes/class_arraymesh.rst | 4 +- classes/class_arvranchor.rst | 4 +- classes/class_arvrcamera.rst | 4 +- classes/class_arvrcontroller.rst | 4 +- classes/class_arvrinterface.rst | 4 +- classes/class_arvrinterfacegdnative.rst | 4 +- classes/class_arvrorigin.rst | 4 +- classes/class_arvrpositionaltracker.rst | 4 +- classes/class_arvrserver.rst | 4 +- classes/class_aspectratiocontainer.rst | 4 +- classes/class_astar.rst | 4 +- classes/class_astar2d.rst | 4 +- classes/class_atlastexture.rst | 4 +- classes/class_audiobuslayout.rst | 4 +- classes/class_audioeffect.rst | 4 +- classes/class_audioeffectamplify.rst | 4 +- classes/class_audioeffectbandlimitfilter.rst | 4 +- classes/class_audioeffectbandpassfilter.rst | 4 +- classes/class_audioeffectcapture.rst | 4 +- classes/class_audioeffectchorus.rst | 4 +- classes/class_audioeffectcompressor.rst | 4 +- classes/class_audioeffectdelay.rst | 4 +- classes/class_audioeffectdistortion.rst | 4 +- classes/class_audioeffecteq.rst | 4 +- classes/class_audioeffecteq10.rst | 4 +- classes/class_audioeffecteq21.rst | 4 +- classes/class_audioeffecteq6.rst | 4 +- classes/class_audioeffectfilter.rst | 4 +- classes/class_audioeffecthighpassfilter.rst | 4 +- classes/class_audioeffecthighshelffilter.rst | 4 +- classes/class_audioeffectinstance.rst | 4 +- classes/class_audioeffectlimiter.rst | 4 +- classes/class_audioeffectlowpassfilter.rst | 4 +- classes/class_audioeffectlowshelffilter.rst | 4 +- classes/class_audioeffectnotchfilter.rst | 4 +- classes/class_audioeffectpanner.rst | 4 +- classes/class_audioeffectphaser.rst | 4 +- classes/class_audioeffectpitchshift.rst | 4 +- classes/class_audioeffectrecord.rst | 4 +- classes/class_audioeffectreverb.rst | 4 +- classes/class_audioeffectspectrumanalyzer.rst | 4 +- ...ss_audioeffectspectrumanalyzerinstance.rst | 4 +- classes/class_audioeffectstereoenhance.rst | 4 +- classes/class_audioserver.rst | 6 +- classes/class_audiostream.rst | 4 +- classes/class_audiostreamgenerator.rst | 4 +- .../class_audiostreamgeneratorplayback.rst | 4 +- classes/class_audiostreammicrophone.rst | 4 +- classes/class_audiostreammp3.rst | 4 +- classes/class_audiostreamoggvorbis.rst | 4 +- classes/class_audiostreamplayback.rst | 4 +- .../class_audiostreamplaybackresampled.rst | 4 +- classes/class_audiostreamplayer.rst | 4 +- classes/class_audiostreamplayer2d.rst | 4 +- classes/class_audiostreamplayer3d.rst | 4 +- classes/class_audiostreamrandompitch.rst | 4 +- classes/class_audiostreamsample.rst | 4 +- classes/class_backbuffercopy.rst | 4 +- classes/class_bakedlightmap.rst | 4 +- classes/class_bakedlightmapdata.rst | 4 +- classes/class_basebutton.rst | 4 +- classes/class_basis.rst | 4 +- classes/class_bitmap.rst | 4 +- classes/class_bitmapfont.rst | 4 +- classes/class_bone2d.rst | 6 +- classes/class_boneattachment.rst | 4 +- classes/class_bool.rst | 4 +- classes/class_boxcontainer.rst | 4 +- classes/class_boxshape.rst | 4 +- classes/class_button.rst | 4 +- classes/class_buttongroup.rst | 4 +- classes/class_callbacktweener.rst | 4 +- classes/class_camera.rst | 27 +- classes/class_camera2d.rst | 4 +- classes/class_camerafeed.rst | 4 +- classes/class_cameraserver.rst | 4 +- classes/class_cameratexture.rst | 4 +- classes/class_canvasitem.rst | 8 +- classes/class_canvasitemmaterial.rst | 4 +- classes/class_canvaslayer.rst | 6 +- classes/class_canvasmodulate.rst | 4 +- classes/class_capsulemesh.rst | 4 +- classes/class_capsuleshape.rst | 4 +- classes/class_capsuleshape2d.rst | 4 +- classes/class_centercontainer.rst | 4 +- classes/class_charfxtransform.rst | 4 +- classes/class_checkbox.rst | 4 +- classes/class_checkbutton.rst | 4 +- classes/class_circleshape2d.rst | 4 +- classes/class_classdb.rst | 4 +- classes/class_clippedcamera.rst | 4 +- classes/class_collisionobject.rst | 6 +- classes/class_collisionobject2d.rst | 4 +- classes/class_collisionpolygon.rst | 6 +- classes/class_collisionpolygon2d.rst | 4 +- classes/class_collisionshape.rst | 6 +- classes/class_collisionshape2d.rst | 4 +- classes/class_color.rst | 4 +- classes/class_colorpicker.rst | 4 +- classes/class_colorpickerbutton.rst | 4 +- classes/class_colorrect.rst | 4 +- classes/class_concavepolygonshape.rst | 4 +- classes/class_concavepolygonshape2d.rst | 4 +- classes/class_conetwistjoint.rst | 4 +- classes/class_configfile.rst | 4 +- classes/class_confirmationdialog.rst | 4 +- classes/class_container.rst | 4 +- classes/class_control.rst | 144 +- classes/class_convexpolygonshape.rst | 4 +- classes/class_convexpolygonshape2d.rst | 4 +- classes/class_cpuparticles.rst | 14 +- classes/class_cpuparticles2d.rst | 260 +- classes/class_crypto.rst | 4 +- classes/class_cryptokey.rst | 4 +- classes/class_csgbox.rst | 4 +- classes/class_csgcombiner.rst | 4 +- classes/class_csgcylinder.rst | 4 +- classes/class_csgmesh.rst | 4 +- classes/class_csgpolygon.rst | 4 +- classes/class_csgprimitive.rst | 4 +- classes/class_csgshape.rst | 4 +- classes/class_csgsphere.rst | 4 +- classes/class_csgtorus.rst | 4 +- classes/class_csharpscript.rst | 4 +- classes/class_cubemap.rst | 4 +- classes/class_cubemesh.rst | 4 +- classes/class_cullinstance.rst | 8 +- classes/class_curve.rst | 4 +- classes/class_curve2d.rst | 4 +- classes/class_curve3d.rst | 4 +- classes/class_curvetexture.rst | 4 +- classes/class_cylindermesh.rst | 4 +- classes/class_cylindershape.rst | 4 +- classes/class_dampedspringjoint2d.rst | 4 +- classes/class_dictionary.rst | 18 +- classes/class_directionallight.rst | 37 +- classes/class_directory.rst | 4 +- classes/class_dtlsserver.rst | 4 +- classes/class_dynamicfont.rst | 4 +- classes/class_dynamicfontdata.rst | 4 +- classes/class_editorexportplugin.rst | 4 +- classes/class_editorfeatureprofile.rst | 4 +- classes/class_editorfiledialog.rst | 4 +- classes/class_editorfilesystem.rst | 4 +- classes/class_editorfilesystemdirectory.rst | 4 +- classes/class_editorimportplugin.rst | 4 +- classes/class_editorinspector.rst | 24 +- classes/class_editorinspectorplugin.rst | 4 +- classes/class_editorinterface.rst | 4 +- classes/class_editorplugin.rst | 4 +- classes/class_editorproperty.rst | 4 +- .../class_editorresourceconversionplugin.rst | 4 +- classes/class_editorresourcepicker.rst | 4 +- classes/class_editorresourcepreview.rst | 4 +- .../class_editorresourcepreviewgenerator.rst | 4 +- classes/class_editorsceneimporter.rst | 4 +- classes/class_editorsceneimporterfbx.rst | 4 +- classes/class_editorsceneimportergltf.rst | 4 +- classes/class_editorscenepostimport.rst | 4 +- classes/class_editorscript.rst | 4 +- classes/class_editorscriptpicker.rst | 4 +- classes/class_editorselection.rst | 4 +- classes/class_editorsettings.rst | 100 +- classes/class_editorspatialgizmo.rst | 4 +- classes/class_editorspatialgizmoplugin.rst | 12 +- classes/class_editorspinslider.rst | 4 +- classes/class_editorvcsinterface.rst | 4 +- classes/class_encodedobjectasid.rst | 4 +- classes/class_engine.rst | 6 +- classes/class_environment.rst | 4 +- classes/class_expression.rst | 4 +- classes/class_externaltexture.rst | 4 +- classes/class_file.rst | 4 +- classes/class_filedialog.rst | 4 +- classes/class_filesystemdock.rst | 4 +- classes/class_float.rst | 4 +- classes/class_flowcontainer.rst | 4 +- classes/class_font.rst | 4 +- classes/class_funcref.rst | 4 +- classes/class_gdnative.rst | 4 +- classes/class_gdnativelibrary.rst | 4 +- classes/class_gdscript.rst | 4 +- classes/class_gdscriptfunctionstate.rst | 4 +- classes/class_generic6dofjoint.rst | 4 +- classes/class_geometry.rst | 4 +- classes/class_geometryinstance.rst | 88 +- classes/class_giprobe.rst | 4 +- classes/class_giprobedata.rst | 4 +- classes/class_gltfaccessor.rst | 4 +- classes/class_gltfanimation.rst | 4 +- classes/class_gltfbufferview.rst | 4 +- classes/class_gltfcamera.rst | 4 +- classes/class_gltfcollider.rst | 227 ++ classes/class_gltfdocument.rst | 4 +- classes/class_gltfdocumentextension.rst | 70 +- classes/class_gltflight.rst | 4 +- classes/class_gltfmesh.rst | 4 +- classes/class_gltfnode.rst | 56 +- classes/class_gltfphysicsbody.rst | 168 + classes/class_gltfskeleton.rst | 4 +- classes/class_gltfskin.rst | 4 +- classes/class_gltfspecgloss.rst | 31 +- classes/class_gltfstate.rst | 50 +- classes/class_gltftexture.rst | 4 +- classes/class_gltftexturesampler.rst | 4 +- classes/class_godotsharp.rst | 4 +- classes/class_gradient.rst | 4 +- classes/class_gradienttexture.rst | 4 +- classes/class_gradienttexture2d.rst | 4 +- classes/class_graphedit.rst | 4 +- classes/class_graphnode.rst | 4 +- classes/class_gridcontainer.rst | 4 +- classes/class_gridmap.rst | 4 +- classes/class_groovejoint2d.rst | 4 +- classes/class_hashingcontext.rst | 4 +- classes/class_hboxcontainer.rst | 4 +- classes/class_heightmapshape.rst | 4 +- classes/class_hflowcontainer.rst | 4 +- classes/class_hingejoint.rst | 4 +- classes/class_hmaccontext.rst | 4 +- classes/class_hscrollbar.rst | 4 +- classes/class_hseparator.rst | 4 +- classes/class_hslider.rst | 4 +- classes/class_hsplitcontainer.rst | 4 +- classes/class_httpclient.rst | 4 +- classes/class_httprequest.rst | 4 +- classes/class_image.rst | 22 +- classes/class_imagetexture.rst | 6 +- classes/class_immediategeometry.rst | 4 +- classes/class_input.rst | 34 +- classes/class_inputevent.rst | 32 +- classes/class_inputeventaction.rst | 4 +- classes/class_inputeventgesture.rst | 4 +- classes/class_inputeventjoypadbutton.rst | 6 +- classes/class_inputeventjoypadmotion.rst | 4 +- classes/class_inputeventkey.rst | 4 +- classes/class_inputeventmagnifygesture.rst | 11 +- classes/class_inputeventmidi.rst | 4 +- classes/class_inputeventmouse.rst | 4 +- classes/class_inputeventmousebutton.rst | 25 +- classes/class_inputeventmousemotion.rst | 4 +- classes/class_inputeventpangesture.rst | 11 +- classes/class_inputeventscreendrag.rst | 4 +- classes/class_inputeventscreentouch.rst | 23 +- classes/class_inputeventwithmodifiers.rst | 4 +- classes/class_inputmap.rst | 4 +- classes/class_instanceplaceholder.rst | 4 +- classes/class_int.rst | 4 +- classes/class_interpolatedcamera.rst | 4 +- classes/class_intervaltweener.rst | 4 +- classes/class_ip.rst | 4 +- classes/class_itemlist.rst | 23 +- classes/class_javaclass.rst | 4 +- classes/class_javaclasswrapper.rst | 4 +- classes/class_javascript.rst | 4 +- classes/class_javascriptobject.rst | 4 +- classes/class_jnisingleton.rst | 4 +- classes/class_joint.rst | 4 +- classes/class_joint2d.rst | 4 +- classes/class_json.rst | 4 +- classes/class_jsonparseresult.rst | 4 +- classes/class_jsonrpc.rst | 4 +- classes/class_kinematicbody.rst | 6 +- classes/class_kinematicbody2d.rst | 4 +- classes/class_kinematiccollision.rst | 4 +- classes/class_kinematiccollision2d.rst | 4 +- classes/class_label.rst | 4 +- classes/class_label3d.rst | 98 +- classes/class_largetexture.rst | 4 +- classes/class_light.rst | 14 +- classes/class_light2d.rst | 4 +- classes/class_lightoccluder2d.rst | 4 +- classes/class_line2d.rst | 4 +- classes/class_lineedit.rst | 4 +- classes/class_lineshape2d.rst | 4 +- classes/class_linkbutton.rst | 4 +- classes/class_listener.rst | 4 +- classes/class_listener2d.rst | 4 +- classes/class_lod.rst | 88 + classes/class_mainloop.rst | 10 +- classes/class_margincontainer.rst | 4 +- classes/class_marshalls.rst | 4 +- classes/class_material.rst | 6 +- classes/class_material3d.rst | 3033 +++++++++++++++++ classes/class_menubutton.rst | 4 +- classes/class_mergegroup.rst | 320 ++ classes/class_mesh.rst | 14 +- classes/class_meshdatatool.rst | 4 +- classes/class_meshinstance.rst | 50 +- classes/class_meshinstance2d.rst | 4 +- classes/class_meshlibrary.rst | 4 +- classes/class_meshtexture.rst | 4 +- classes/class_methodtweener.rst | 4 +- classes/class_mobilevrinterface.rst | 4 +- classes/class_multimesh.rst | 6 +- classes/class_multimeshinstance.rst | 4 +- classes/class_multimeshinstance2d.rst | 4 +- classes/class_multiplayerapi.rst | 4 +- classes/class_multiplayerpeergdnative.rst | 4 +- classes/class_mutex.rst | 16 +- classes/class_nativescript.rst | 4 +- classes/class_navigation.rst | 4 +- classes/class_navigation2d.rst | 4 +- classes/class_navigation2dserver.rst | 4 +- classes/class_navigationagent.rst | 4 +- classes/class_navigationagent2d.rst | 4 +- classes/class_navigationmesh.rst | 4 +- classes/class_navigationmeshgenerator.rst | 4 +- classes/class_navigationmeshinstance.rst | 4 +- classes/class_navigationobstacle.rst | 4 +- classes/class_navigationobstacle2d.rst | 4 +- classes/class_navigationpolygon.rst | 4 +- classes/class_navigationpolygoninstance.rst | 4 +- classes/class_navigationserver.rst | 4 +- classes/class_networkedmultiplayercustom.rst | 8 +- classes/class_networkedmultiplayerenet.rst | 4 +- classes/class_networkedmultiplayerpeer.rst | 8 +- classes/class_ninepatchrect.rst | 4 +- classes/class_node.rst | 48 +- classes/class_node2d.rst | 4 +- classes/class_nodepath.rst | 7 +- classes/class_noisetexture.rst | 4 +- classes/class_object.rst | 4 +- classes/class_occluder.rst | 4 +- classes/class_occluderpolygon2d.rst | 4 +- classes/class_occludershape.rst | 4 +- classes/class_occludershapepolygon.rst | 4 +- classes/class_occludershapesphere.rst | 4 +- classes/class_omnilight.rst | 4 +- classes/class_opensimplexnoise.rst | 4 +- classes/class_optionbutton.rst | 6 +- classes/class_ormspatialmaterial.rst | 27 + classes/class_os.rst | 24 +- classes/class_packeddatacontainer.rst | 4 +- classes/class_packeddatacontainerref.rst | 4 +- classes/class_packedscene.rst | 4 +- classes/class_packedscenegltf.rst | 4 +- classes/class_packetpeer.rst | 4 +- classes/class_packetpeerdtls.rst | 4 +- classes/class_packetpeergdnative.rst | 4 +- classes/class_packetpeerstream.rst | 4 +- classes/class_packetpeerudp.rst | 4 +- classes/class_panel.rst | 4 +- classes/class_panelcontainer.rst | 4 +- classes/class_panoramasky.rst | 4 +- classes/class_parallaxbackground.rst | 4 +- classes/class_parallaxlayer.rst | 20 +- classes/class_particles.rst | 23 +- classes/class_particles2d.rst | 25 +- classes/class_particlesmaterial.rst | 18 +- classes/class_path.rst | 4 +- classes/class_path2d.rst | 4 +- classes/class_pathfollow.rst | 4 +- classes/class_pathfollow2d.rst | 4 +- classes/class_pckpacker.rst | 4 +- classes/class_performance.rst | 6 +- classes/class_phashtranslation.rst | 4 +- classes/class_physicalbone.rst | 11 +- classes/class_physics2ddirectbodystate.rst | 4 +- classes/class_physics2ddirectspacestate.rst | 4 +- classes/class_physics2dserver.rst | 4 +- .../class_physics2dshapequeryparameters.rst | 4 +- classes/class_physics2dtestmotionresult.rst | 4 +- classes/class_physicsbody.rst | 6 +- classes/class_physicsbody2d.rst | 4 +- classes/class_physicsdirectbodystate.rst | 4 +- classes/class_physicsdirectspacestate.rst | 4 +- classes/class_physicsmaterial.rst | 4 +- classes/class_physicsserver.rst | 4 +- classes/class_physicsshapequeryparameters.rst | 4 +- classes/class_physicstestmotionresult.rst | 4 +- classes/class_pinjoint.rst | 4 +- classes/class_pinjoint2d.rst | 4 +- classes/class_plane.rst | 4 +- classes/class_planemesh.rst | 4 +- classes/class_planeshape.rst | 4 +- classes/class_pluginscript.rst | 4 +- classes/class_pointmesh.rst | 6 +- classes/class_polygon2d.rst | 4 +- classes/class_polygonpathfinder.rst | 4 +- classes/class_poolbytearray.rst | 4 +- classes/class_poolcolorarray.rst | 4 +- classes/class_poolintarray.rst | 4 +- classes/class_poolrealarray.rst | 4 +- classes/class_poolstringarray.rst | 4 +- classes/class_poolvector2array.rst | 4 +- classes/class_poolvector3array.rst | 4 +- classes/class_popup.rst | 4 +- classes/class_popupdialog.rst | 4 +- classes/class_popupmenu.rst | 6 +- classes/class_popuppanel.rst | 4 +- classes/class_portal.rst | 23 +- classes/class_position2d.rst | 4 +- classes/class_position3d.rst | 4 +- classes/class_primitivemesh.rst | 6 +- classes/class_prismmesh.rst | 4 +- classes/class_proceduralsky.rst | 4 +- classes/class_progressbar.rst | 4 +- classes/class_projectsettings.rst | 2194 ++++++------ classes/class_propertytweener.rst | 4 +- classes/class_proximitygroup.rst | 4 +- classes/class_proxytexture.rst | 4 +- classes/class_quadmesh.rst | 4 +- classes/class_quat.rst | 4 +- classes/class_randomnumbergenerator.rst | 4 +- classes/class_range.rst | 4 +- classes/class_raycast.rst | 4 +- classes/class_raycast2d.rst | 4 +- classes/class_rayshape.rst | 4 +- classes/class_rayshape2d.rst | 4 +- classes/class_rect2.rst | 4 +- classes/class_rectangleshape2d.rst | 4 +- classes/class_reference.rst | 4 +- classes/class_referencerect.rst | 4 +- classes/class_reflectionprobe.rst | 4 +- classes/class_regex.rst | 4 +- classes/class_regexmatch.rst | 4 +- classes/class_remotetransform.rst | 4 +- classes/class_remotetransform2d.rst | 4 +- classes/class_resource.rst | 74 +- classes/class_resourceformatloader.rst | 4 +- classes/class_resourceformatsaver.rst | 4 +- classes/class_resourceimporter.rst | 4 +- classes/class_resourceinteractiveloader.rst | 4 +- classes/class_resourceloader.rst | 4 +- classes/class_resourcepreloader.rst | 4 +- classes/class_resourcesaver.rst | 4 +- classes/class_richtexteffect.rst | 4 +- classes/class_richtextlabel.rst | 4 +- classes/class_rid.rst | 4 +- classes/class_rigidbody.rst | 26 +- classes/class_rigidbody2d.rst | 24 +- classes/class_room.rst | 4 +- classes/class_roomgroup.rst | 4 +- classes/class_roommanager.rst | 4 +- classes/class_rootmotionview.rst | 4 +- classes/class_scenestate.rst | 4 +- classes/class_scenetree.rst | 18 +- classes/class_scenetreetimer.rst | 4 +- classes/class_scenetreetween.rst | 6 +- classes/class_script.rst | 4 +- classes/class_scriptcreatedialog.rst | 4 +- classes/class_scripteditor.rst | 18 +- classes/class_scrollbar.rst | 4 +- classes/class_scrollcontainer.rst | 18 +- classes/class_segmentshape2d.rst | 4 +- classes/class_semaphore.rst | 12 +- classes/class_separator.rst | 4 +- classes/class_shader.rst | 4 +- classes/class_shadermaterial.rst | 4 +- classes/class_shape.rst | 4 +- classes/class_shape2d.rst | 4 +- classes/class_shapecast.rst | 4 +- classes/class_shapecast2d.rst | 4 +- classes/class_shortcut.rst | 4 +- classes/class_skeleton.rst | 4 +- classes/class_skeleton2d.rst | 4 +- classes/class_skeletonik.rst | 4 +- classes/class_skin.rst | 4 +- classes/class_skinreference.rst | 4 +- classes/class_sky.rst | 4 +- classes/class_slider.rst | 4 +- classes/class_sliderjoint.rst | 4 +- classes/class_softbody.rst | 4 +- classes/class_spatial.rst | 175 +- classes/class_spatialgizmo.rst | 4 +- classes/class_spatialmaterial.rst | 2998 +--------------- classes/class_spatialvelocitytracker.rst | 4 +- classes/class_spheremesh.rst | 4 +- classes/class_sphereshape.rst | 4 +- classes/class_spinbox.rst | 4 +- classes/class_splitcontainer.rst | 4 +- classes/class_spotlight.rst | 4 +- classes/class_springarm.rst | 4 +- classes/class_sprite.rst | 4 +- classes/class_sprite3d.rst | 4 +- classes/class_spritebase3d.rst | 80 +- classes/class_spriteframes.rst | 4 +- classes/class_staticbody.rst | 10 +- classes/class_staticbody2d.rst | 4 +- classes/class_streampeer.rst | 4 +- classes/class_streampeerbuffer.rst | 4 +- classes/class_streampeergdnative.rst | 4 +- classes/class_streampeerssl.rst | 4 +- classes/class_streampeertcp.rst | 4 +- classes/class_streamtexture.rst | 4 +- classes/class_string.rst | 6 +- classes/class_stylebox.rst | 4 +- classes/class_styleboxempty.rst | 4 +- classes/class_styleboxflat.rst | 4 +- classes/class_styleboxline.rst | 4 +- classes/class_styleboxtexture.rst | 4 +- classes/class_surfacetool.rst | 6 +- classes/class_tabcontainer.rst | 102 +- classes/class_tabs.rst | 32 +- classes/class_tcp_server.rst | 4 +- classes/class_textedit.rst | 4 +- classes/class_textfile.rst | 4 +- classes/class_textmesh.rst | 4 +- classes/class_texture.rst | 4 +- classes/class_texture3d.rst | 4 +- classes/class_texturearray.rst | 4 +- classes/class_texturebutton.rst | 4 +- classes/class_texturelayered.rst | 4 +- classes/class_textureprogress.rst | 4 +- classes/class_texturerect.rst | 4 +- classes/class_theme.rst | 4 +- classes/class_thread.rst | 14 +- classes/class_tilemap.rst | 4 +- classes/class_tileset.rst | 60 +- classes/class_time.rst | 4 +- classes/class_timer.rst | 8 +- classes/class_toolbutton.rst | 4 +- classes/class_torusmesh.rst | 4 +- classes/class_touchscreenbutton.rst | 4 +- classes/class_transform.rst | 4 +- classes/class_transform2d.rst | 20 +- classes/class_translation.rst | 4 +- classes/class_translationserver.rst | 4 +- classes/class_tree.rst | 23 +- classes/class_treeitem.rst | 6 +- classes/class_trianglemesh.rst | 4 +- classes/class_tween.rst | 6 +- classes/class_tweener.rst | 4 +- classes/class_udpserver.rst | 4 +- classes/class_undoredo.rst | 4 +- classes/class_upnp.rst | 4 +- classes/class_upnpdevice.rst | 4 +- classes/class_variant.rst | 4 +- classes/class_vboxcontainer.rst | 4 +- classes/class_vector2.rst | 24 +- classes/class_vector3.rst | 22 +- classes/class_vehiclebody.rst | 6 +- classes/class_vehiclewheel.rst | 4 +- classes/class_vflowcontainer.rst | 4 +- classes/class_videoplayer.rst | 23 +- classes/class_videostream.rst | 4 +- classes/class_videostreamgdnative.rst | 4 +- classes/class_videostreamtheora.rst | 4 +- classes/class_videostreamwebm.rst | 4 +- classes/class_viewport.rst | 144 +- classes/class_viewportcontainer.rst | 4 +- classes/class_viewporttexture.rst | 4 +- classes/class_visibilityenabler.rst | 4 +- classes/class_visibilityenabler2d.rst | 4 +- classes/class_visibilitynotifier.rst | 4 +- classes/class_visibilitynotifier2d.rst | 4 +- classes/class_visualinstance.rst | 4 +- classes/class_visualscript.rst | 4 +- .../class_visualscriptbasictypeconstant.rst | 4 +- classes/class_visualscriptbuiltinfunc.rst | 4 +- classes/class_visualscriptclassconstant.rst | 4 +- classes/class_visualscriptcomment.rst | 4 +- classes/class_visualscriptcomposearray.rst | 4 +- classes/class_visualscriptcondition.rst | 4 +- classes/class_visualscriptconstant.rst | 4 +- classes/class_visualscriptconstructor.rst | 4 +- classes/class_visualscriptcustomnode.rst | 4 +- classes/class_visualscriptdeconstruct.rst | 4 +- classes/class_visualscripteditor.rst | 4 +- classes/class_visualscriptemitsignal.rst | 4 +- classes/class_visualscriptenginesingleton.rst | 4 +- classes/class_visualscriptexpression.rst | 4 +- classes/class_visualscriptfunction.rst | 4 +- classes/class_visualscriptfunctioncall.rst | 4 +- classes/class_visualscriptfunctionstate.rst | 4 +- classes/class_visualscriptglobalconstant.rst | 4 +- classes/class_visualscriptindexget.rst | 4 +- classes/class_visualscriptindexset.rst | 4 +- classes/class_visualscriptinputaction.rst | 4 +- classes/class_visualscriptiterator.rst | 4 +- classes/class_visualscriptlists.rst | 4 +- classes/class_visualscriptlocalvar.rst | 4 +- classes/class_visualscriptlocalvarset.rst | 4 +- classes/class_visualscriptmathconstant.rst | 4 +- classes/class_visualscriptnode.rst | 4 +- classes/class_visualscriptoperator.rst | 4 +- classes/class_visualscriptpreload.rst | 4 +- classes/class_visualscriptpropertyget.rst | 4 +- classes/class_visualscriptpropertyset.rst | 4 +- classes/class_visualscriptresourcepath.rst | 4 +- classes/class_visualscriptreturn.rst | 4 +- classes/class_visualscriptscenenode.rst | 4 +- classes/class_visualscriptscenetree.rst | 4 +- classes/class_visualscriptselect.rst | 4 +- classes/class_visualscriptself.rst | 4 +- classes/class_visualscriptsequence.rst | 4 +- classes/class_visualscriptsubcall.rst | 4 +- classes/class_visualscriptswitch.rst | 4 +- classes/class_visualscripttypecast.rst | 4 +- classes/class_visualscriptvariableget.rst | 4 +- classes/class_visualscriptvariableset.rst | 4 +- classes/class_visualscriptwhile.rst | 4 +- classes/class_visualscriptyield.rst | 4 +- classes/class_visualscriptyieldsignal.rst | 4 +- classes/class_visualserver.rst | 260 +- classes/class_visualshader.rst | 4 +- classes/class_visualshadernode.rst | 4 +- .../class_visualshadernodebooleanconstant.rst | 4 +- .../class_visualshadernodebooleanuniform.rst | 4 +- .../class_visualshadernodecolorconstant.rst | 4 +- classes/class_visualshadernodecolorfunc.rst | 4 +- classes/class_visualshadernodecolorop.rst | 4 +- .../class_visualshadernodecoloruniform.rst | 4 +- classes/class_visualshadernodecompare.rst | 4 +- classes/class_visualshadernodecubemap.rst | 4 +- .../class_visualshadernodecubemapuniform.rst | 4 +- classes/class_visualshadernodecustom.rst | 4 +- classes/class_visualshadernodedeterminant.rst | 4 +- classes/class_visualshadernodedotproduct.rst | 4 +- classes/class_visualshadernodeexpression.rst | 4 +- classes/class_visualshadernodefaceforward.rst | 4 +- classes/class_visualshadernodefresnel.rst | 4 +- ...class_visualshadernodeglobalexpression.rst | 4 +- classes/class_visualshadernodegroupbase.rst | 4 +- classes/class_visualshadernodeif.rst | 4 +- classes/class_visualshadernodeinput.rst | 4 +- classes/class_visualshadernodeis.rst | 4 +- .../class_visualshadernodeouterproduct.rst | 4 +- classes/class_visualshadernodeoutput.rst | 4 +- classes/class_visualshadernodescalarclamp.rst | 4 +- .../class_visualshadernodescalarconstant.rst | 4 +- ...s_visualshadernodescalarderivativefunc.rst | 4 +- classes/class_visualshadernodescalarfunc.rst | 4 +- .../class_visualshadernodescalarinterp.rst | 4 +- classes/class_visualshadernodescalarop.rst | 4 +- ...class_visualshadernodescalarsmoothstep.rst | 4 +- .../class_visualshadernodescalarswitch.rst | 4 +- .../class_visualshadernodescalaruniform.rst | 4 +- classes/class_visualshadernodeswitch.rst | 4 +- classes/class_visualshadernodetexture.rst | 4 +- .../class_visualshadernodetextureuniform.rst | 4 +- ...isualshadernodetextureuniformtriplanar.rst | 4 +- ...class_visualshadernodetransformcompose.rst | 4 +- ...lass_visualshadernodetransformconstant.rst | 4 +- ...ass_visualshadernodetransformdecompose.rst | 4 +- .../class_visualshadernodetransformfunc.rst | 4 +- .../class_visualshadernodetransformmult.rst | 4 +- ...class_visualshadernodetransformuniform.rst | 4 +- ...class_visualshadernodetransformvecmult.rst | 4 +- classes/class_visualshadernodeuniform.rst | 4 +- classes/class_visualshadernodeuniformref.rst | 4 +- .../class_visualshadernodevec3constant.rst | 4 +- classes/class_visualshadernodevec3uniform.rst | 4 +- classes/class_visualshadernodevectorclamp.rst | 4 +- .../class_visualshadernodevectorcompose.rst | 4 +- .../class_visualshadernodevectordecompose.rst | 4 +- ...s_visualshadernodevectorderivativefunc.rst | 4 +- .../class_visualshadernodevectordistance.rst | 4 +- classes/class_visualshadernodevectorfunc.rst | 4 +- .../class_visualshadernodevectorinterp.rst | 4 +- classes/class_visualshadernodevectorlen.rst | 4 +- classes/class_visualshadernodevectorop.rst | 4 +- .../class_visualshadernodevectorrefract.rst | 4 +- .../class_visualshadernodevectorscalarmix.rst | 4 +- ...visualshadernodevectorscalarsmoothstep.rst | 4 +- ...class_visualshadernodevectorscalarstep.rst | 4 +- ...class_visualshadernodevectorsmoothstep.rst | 4 +- classes/class_vscrollbar.rst | 4 +- classes/class_vseparator.rst | 4 +- classes/class_vslider.rst | 4 +- classes/class_vsplitcontainer.rst | 4 +- classes/class_weakref.rst | 4 +- classes/class_webrtcdatachannel.rst | 4 +- classes/class_webrtcdatachannelgdnative.rst | 4 +- classes/class_webrtcmultiplayer.rst | 4 +- classes/class_webrtcpeerconnection.rst | 4 +- .../class_webrtcpeerconnectiongdnative.rst | 4 +- classes/class_websocketclient.rst | 4 +- classes/class_websocketmultiplayerpeer.rst | 4 +- classes/class_websocketpeer.rst | 4 +- classes/class_websocketserver.rst | 4 +- classes/class_webxrinterface.rst | 4 +- classes/class_windowdialog.rst | 4 +- classes/class_world.rst | 4 +- classes/class_world2d.rst | 4 +- classes/class_worldenvironment.rst | 4 +- classes/class_x509certificate.rst | 4 +- classes/class_xmlparser.rst | 4 +- classes/class_ysort.rst | 4 +- classes/index.rst | 8 +- 715 files changed, 8250 insertions(+), 6261 deletions(-) create mode 100644 classes/class_gltfcollider.rst create mode 100644 classes/class_gltfphysicsbody.rst create mode 100644 classes/class_lod.rst create mode 100644 classes/class_material3d.rst create mode 100644 classes/class_mergegroup.rst create mode 100644 classes/class_ormspatialmaterial.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 3d2f6ec77..aac92fe83 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdscript/doc_classes/@GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdscript/doc_classes/@GDScript.xml. .. _class_@GDScript: @@ -335,7 +335,7 @@ Returns the absolute value of parameter ``s`` (i.e. positive value). :ref:`float` **acos** **(** :ref:`float` s **)** -Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``. ``s`` must be between ``-1.0`` and ``1.0`` (inclusive), otherwise, :ref:`acos` will return :ref:`NAN`. +Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``. ``s`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`acos` from returning :ref:`NAN`. :: @@ -352,7 +352,7 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s`` :ref:`float` **asin** **(** :ref:`float` s **)** -Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. ``s`` must be between ``-1.0`` and ``1.0`` (inclusive), otherwise, :ref:`asin` will return :ref:`NAN`. +Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. ``s`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`asin` from returning :ref:`NAN`. :: @@ -671,7 +671,7 @@ Returns an "eased" value of ``x`` based on an easing function defined with ``cur - 1.0: Linear - Greater than 1.0 (exclusive): Ease in -\ `ease() curve values cheatsheet `__\ +\ `ease() curve values cheatsheet `__\ See also :ref:`smoothstep`. If you need to perform more advanced transitions, use :ref:`Tween` or :ref:`AnimationPlayer`. @@ -1088,9 +1088,9 @@ This method is a simplified version of :ref:`ResourceLoader.load` **log** **(** :ref:`float` s **)** -Natural logarithm. The amount of time needed to reach a certain level of continuous growth. +Returns the `natural logarithm `__ of ``s`` (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. -\ **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. +\ **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use ``log(x) / log(10)``. :: @@ -1735,7 +1735,7 @@ This S-shaped curve is the cubic Hermite interpolator, given by ``f(y) = 3*y^2 - Compared to :ref:`ease` with a curve value of ``-1.6521``, :ref:`smoothstep` returns the smoothest possible curve with no sudden changes in the derivative. If you need to perform more advanced transitions, use :ref:`Tween` or :ref:`AnimationPlayer`. -\ `Comparison between smoothstep() and ease(x, -1.6521) return values `__ +\ `Comparison between smoothstep() and ease(x, -1.6521) return values `__ .. rst-class:: classref-item-separator diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index a1e8e1095..dba971903 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/@GlobalScope.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/@GlobalScope.xml. .. _class_@GlobalScope: @@ -3913,7 +3913,7 @@ Hint that a property represents a particular type. If a property is :ref:`TYPE_S :: - hint_string = "%s:" % [TYPE_INT] # Array of inteters. + hint_string = "%s:" % [TYPE_INT] # Array of integers. hint_string = "%s:%s:" % [TYPE_ARRAY, TYPE_REAL] # Two-dimensional array of floats. hint_string = "%s/%s:Resource" % [TYPE_OBJECT, TYPE_OBJECT] # Array of resources. hint_string = "%s:%s/%s:Resource" % [TYPE_ARRAY, TYPE_OBJECT, TYPE_OBJECT] # Two-dimensional array of resources. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 200adc805..9d0e6037c 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AABB.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AABB.xml. .. _class_AABB: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 6271b7252..cc6a0979a 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AcceptDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AcceptDialog.xml. .. _class_AcceptDialog: diff --git a/classes/class_aescontext.rst b/classes/class_aescontext.rst index 6419fc299..9090b79a5 100644 --- a/classes/class_aescontext.rst +++ b/classes/class_aescontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AESContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AESContext.xml. .. _class_AESContext: diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 3e5c887fe..905e599a2 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimatedSprite.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimatedSprite.xml. .. _class_AnimatedSprite: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 240f2cdf8..4de028991 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimatedSprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimatedSprite3D.xml. .. _class_AnimatedSprite3D: diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 15aeacefe..b3b769228 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimatedTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimatedTexture.xml. .. _class_AnimatedTexture: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 65d5f1044..190f7f067 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Animation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Animation.xml. .. _class_Animation: diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 57d97a1a1..54f12d17a 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNode.xml. .. _class_AnimationNode: diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 5fbca37b7..cbc0feb08 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeAdd2.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeAdd2.xml. .. _class_AnimationNodeAdd2: diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index d29190fde..21191ba84 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeAdd3.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeAdd3.xml. .. _class_AnimationNodeAdd3: diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index 9e21999d6..c26038450 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeAnimation.xml. .. _class_AnimationNodeAnimation: diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 1e4e4553c..3e98edf7e 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeBlend2.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlend2.xml. .. _class_AnimationNodeBlend2: diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 5ad5a59d4..51e4fccd0 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeBlend3.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlend3.xml. .. _class_AnimationNodeBlend3: diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 95cf06d4c..afcbba302 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeBlendSpace1D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlendSpace1D.xml. .. _class_AnimationNodeBlendSpace1D: diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 037b07b1c..d3f36bbae 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeBlendSpace2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlendSpace2D.xml. .. _class_AnimationNodeBlendSpace2D: diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 58c0f583e..7e7939899 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeBlendTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeBlendTree.xml. .. _class_AnimationNodeBlendTree: diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index abd389029..2c12ab323 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeOneShot.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeOneShot.xml. .. _class_AnimationNodeOneShot: diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index 848bf2045..10ffd587f 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeOutput.xml. .. _class_AnimationNodeOutput: diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 3f07460b9..662175804 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeStateMachine.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeStateMachine.xml. .. _class_AnimationNodeStateMachine: diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index a43e7cab7..79ea31d1a 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeStateMachinePlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeStateMachinePlayback.xml. .. _class_AnimationNodeStateMachinePlayback: diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 85b8f478d..442e2c19a 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeStateMachineTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeStateMachineTransition.xml. .. _class_AnimationNodeStateMachineTransition: diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index 64075ebf4..8401a4a81 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeTimeScale.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeTimeScale.xml. .. _class_AnimationNodeTimeScale: diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index 4ee4d025b..96ed1ecb8 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeTimeSeek.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeTimeSeek.xml. .. _class_AnimationNodeTimeSeek: diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 32125fd39..e89691815 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationNodeTransition.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationNodeTransition.xml. .. _class_AnimationNodeTransition: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index e580a6d59..118f34a81 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationPlayer.xml. .. _class_AnimationPlayer: diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index e9b014ed9..064e2fe89 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationRootNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationRootNode.xml. .. _class_AnimationRootNode: diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index d8827037c..a423e3f03 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationTrackEditPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationTrackEditPlugin.xml. .. _class_AnimationTrackEditPlugin: diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index abee8a963..590eb07ae 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationTree.xml. .. _class_AnimationTree: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index c06888a3a..70ac8294a 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AnimationTreePlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AnimationTreePlayer.xml. .. _class_AnimationTreePlayer: diff --git a/classes/class_area.rst b/classes/class_area.rst index 2d2fdfa3f..9c3157be7 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Area.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Area.xml. .. _class_Area: @@ -25,6 +25,8 @@ To give the area its shape, add a :ref:`CollisionShape` or \ **Warning:** See :ref:`ConcavePolygonShape` (also called "trimesh") for a warning about possibly unexpected behavior when using that shape for an area. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-introduction-group Tutorials @@ -143,9 +145,19 @@ Emitted when one of another Area's :ref:`Shape`\ s enters one of th \ ``area`` the other Area. -\ ``area_shape_index`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``area.shape_owner_get_owner(area_shape_index)``. +\ ``area_shape_index`` the index of the :ref:`Shape` from the other Area. -\ ``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` from this Area. + +\ **Example of getting the** :ref:`CollisionShape` **node from the shape index:**\ + +:: + + var other_shape_owner = area.shape_find_owner(area_shape_index) + var other_shape_node = area.shape_owner_get_owner(other_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) .. rst-class:: classref-item-separator @@ -163,9 +175,11 @@ Emitted when one of another Area's :ref:`Shape`\ s enters one of th \ ``area`` the other Area. -\ ``area_shape_index`` the index of the :ref:`Shape` of the other Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``area.shape_owner_get_owner(area_shape_index)``. +\ ``area_shape_index`` the index of the :ref:`Shape` from the other Area. -\ ``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` from this Area. + +See also :ref:`area_shape_entered`. .. rst-class:: classref-item-separator @@ -211,9 +225,19 @@ Emitted when one of a :ref:`PhysicsBody` or :ref:`GridMap`, if it exists in the tree, of the :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``body_shape_index`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape` from the :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` from this Area. + +\ **Example of getting the** :ref:`CollisionShape` **node from the shape index:**\ + +:: + + var body_shape_owner = body.shape_find_owner(body_shape_index) + var body_shape_node = body.shape_owner_get_owner(body_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) .. rst-class:: classref-item-separator @@ -231,9 +255,11 @@ Emitted when one of a :ref:`PhysicsBody` or :ref:`GridMap`, if it exists in the tree, of the :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``body_shape_index`` the index of the :ref:`Shape` of the :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape` from the :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``local_shape_index`` the index of the :ref:`Shape` of this Area used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` from this Area. + +See also :ref:`body_shape_entered`. .. rst-class:: classref-section-separator diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 63f444bb2..29aee6a56 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Area2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Area2D.xml. .. _class_Area2D: @@ -139,9 +139,19 @@ Emitted when one of another Area2D's :ref:`Shape2D`\ s enters one \ ``area`` the other Area2D. -\ ``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. +\ ``area_shape_index`` the index of the :ref:`Shape2D` from the other Area2D. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` from this Area2D. + +\ **Example of getting the** :ref:`CollisionShape2D` **node from the shape index:**\ + +:: + + var other_shape_owner = area.shape_find_owner(area_shape_index) + var other_shape_node = area.shape_owner_get_owner(other_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) .. rst-class:: classref-item-separator @@ -159,9 +169,11 @@ Emitted when one of another Area2D's :ref:`Shape2D`\ s exits one \ ``area`` the other Area2D. -\ ``area_shape_index`` the index of the :ref:`Shape2D` of the other Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``area.shape_owner_get_owner(area_shape_index)``. +\ ``area_shape_index`` the index of the :ref:`Shape2D` from the other Area2D. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` from this Area2D. + +See also :ref:`area_shape_entered`. .. rst-class:: classref-item-separator @@ -207,9 +219,19 @@ Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap \ ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape2D` from the :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` from this Area2D. + +\ **Example of getting the** :ref:`CollisionShape2D` **node from the shape index:**\ + +:: + + var body_shape_owner = body.shape_find_owner(body_shape_index) + var body_shape_node = body.shape_owner_get_owner(body_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) .. rst-class:: classref-item-separator @@ -227,9 +249,11 @@ Emitted when one of a :ref:`PhysicsBody2D` or :ref:`TileMap \ ``body`` the :ref:`Node`, if it exists in the tree, of the :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``body_shape_index`` the index of the :ref:`Shape2D` of the :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape2D` from the :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this Area2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` from this Area2D. + +See also :ref:`body_shape_entered`. .. rst-class:: classref-section-separator diff --git a/classes/class_array.rst b/classes/class_array.rst index 4f5283120..0ddb4985f 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Array.xml. .. _class_Array: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index fa99f5f58..94b183554 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ArrayMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ArrayMesh.xml. .. _class_ArrayMesh: diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index 8a73e093a..2ea0f5739 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRAnchor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRAnchor.xml. .. _class_ARVRAnchor: diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index 573288946..900a30787 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRCamera.xml. .. _class_ARVRCamera: diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 44d3d2188..3c94abcfe 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRController.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRController.xml. .. _class_ARVRController: diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 7551dd9f3..5a77293ff 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRInterface.xml. .. _class_ARVRInterface: diff --git a/classes/class_arvrinterfacegdnative.rst b/classes/class_arvrinterfacegdnative.rst index 2517ff6f5..e7e278394 100644 --- a/classes/class_arvrinterfacegdnative.rst +++ b/classes/class_arvrinterfacegdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml. .. _class_ARVRInterfaceGDNative: diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index c2e574ae1..15dceaad3 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVROrigin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVROrigin.xml. .. _class_ARVROrigin: diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 9491472aa..370db9ca2 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRPositionalTracker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRPositionalTracker.xml. .. _class_ARVRPositionalTracker: diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 38211cc2f..21a7f8d25 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ARVRServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ARVRServer.xml. .. _class_ARVRServer: diff --git a/classes/class_aspectratiocontainer.rst b/classes/class_aspectratiocontainer.rst index b52c17ed6..e413a706c 100644 --- a/classes/class_aspectratiocontainer.rst +++ b/classes/class_aspectratiocontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AspectRatioContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AspectRatioContainer.xml. .. _class_AspectRatioContainer: diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 6350666e4..004d3466c 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AStar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AStar.xml. .. _class_AStar: diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index a7a92b4db..f86da64ec 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AStar2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AStar2D.xml. .. _class_AStar2D: diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index c8639fcec..d2c140bc7 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AtlasTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AtlasTexture.xml. .. _class_AtlasTexture: diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 7a4dafe6c..5f89fabe8 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioBusLayout.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioBusLayout.xml. .. _class_AudioBusLayout: diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 925378a83..c0c0bacfa 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffect.xml. .. _class_AudioEffect: diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index c08bb0324..ed99b9048 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectAmplify.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectAmplify.xml. .. _class_AudioEffectAmplify: diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index ff6bd20b4..0785cfb01 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectBandLimitFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectBandLimitFilter.xml. .. _class_AudioEffectBandLimitFilter: diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index 11fb5e34f..30a11d1ff 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectBandPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectBandPassFilter.xml. .. _class_AudioEffectBandPassFilter: diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index 45da1068c..b98248602 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectCapture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectCapture.xml. .. _class_AudioEffectCapture: diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 2da72c8f9..0dc372402 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectChorus.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectChorus.xml. .. _class_AudioEffectChorus: diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 46d4aa850..698977a9c 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectCompressor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectCompressor.xml. .. _class_AudioEffectCompressor: diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index ccf1cc883..06d5fcdb5 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectDelay.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectDelay.xml. .. _class_AudioEffectDelay: diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 66b8bf39a..98d256d4c 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectDistortion.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectDistortion.xml. .. _class_AudioEffectDistortion: diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index d27962d19..240ac280e 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectEQ.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectEQ.xml. .. _class_AudioEffectEQ: diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 6321adcee..17f59ba0e 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectEQ10.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectEQ10.xml. .. _class_AudioEffectEQ10: diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 51f575226..f67f1a43f 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectEQ21.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectEQ21.xml. .. _class_AudioEffectEQ21: diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 0c16f689f..74f8a465c 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectEQ6.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectEQ6.xml. .. _class_AudioEffectEQ6: diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index eb8dffb31..1c6fee5a0 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectFilter.xml. .. _class_AudioEffectFilter: diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index d75c99146..0066c143f 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectHighPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectHighPassFilter.xml. .. _class_AudioEffectHighPassFilter: diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 951418df8..c32fca89b 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectHighShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectHighShelfFilter.xml. .. _class_AudioEffectHighShelfFilter: diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index c10512bdc..d98e5645a 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectInstance.xml. .. _class_AudioEffectInstance: diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 24b3261ee..072ba07cb 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectLimiter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectLimiter.xml. .. _class_AudioEffectLimiter: diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index 6abfe7192..b019a2ac4 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectLowPassFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectLowPassFilter.xml. .. _class_AudioEffectLowPassFilter: diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 9ff772004..02194670d 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectLowShelfFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectLowShelfFilter.xml. .. _class_AudioEffectLowShelfFilter: diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 4badb94a8..2aeed3cda 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectNotchFilter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectNotchFilter.xml. .. _class_AudioEffectNotchFilter: diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index eec41ab5e..b0125c3cb 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectPanner.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectPanner.xml. .. _class_AudioEffectPanner: diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index aa5af0c33..0fd5f1da1 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectPhaser.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectPhaser.xml. .. _class_AudioEffectPhaser: diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index a6b2f045a..c498d019e 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectPitchShift.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectPitchShift.xml. .. _class_AudioEffectPitchShift: diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index e8d06e22e..0f13eb7fe 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectRecord.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectRecord.xml. .. _class_AudioEffectRecord: diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index de7146625..86ead9b15 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectReverb.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectReverb.xml. .. _class_AudioEffectReverb: diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index a80db5661..3de1dfeeb 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectSpectrumAnalyzer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectSpectrumAnalyzer.xml. .. _class_AudioEffectSpectrumAnalyzer: diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index 33cc9a729..8908aacd2 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml. .. _class_AudioEffectSpectrumAnalyzerInstance: diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 49705ab4b..5b4ecba81 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectStereoEnhance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectStereoEnhance.xml. .. _class_AudioEffectStereoEnhance: diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 61395e59a..4ddb2c8f4 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioServer.xml. .. _class_AudioServer: @@ -486,7 +486,7 @@ Returns the sample rate at the output of the **AudioServer**. :ref:`float` **get_output_latency** **(** **)** |const| -Returns the audio driver's output latency. +Returns the audio driver's output latency. This can be expensive, it is not recommended to call this every frame. .. rst-class:: classref-item-separator diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 39f153ae9..e848a4f19 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStream.xml. .. _class_AudioStream: diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst index 15932636f..0487d4739 100644 --- a/classes/class_audiostreamgenerator.rst +++ b/classes/class_audiostreamgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamGenerator.xml. .. _class_AudioStreamGenerator: diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index e945150c1..57871f853 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamGeneratorPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamGeneratorPlayback.xml. .. _class_AudioStreamGeneratorPlayback: diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index 6eedaa7c9..1a9b81ae9 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamMicrophone.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamMicrophone.xml. .. _class_AudioStreamMicrophone: diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 30c710d19..77ce0de8b 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/minimp3/doc_classes/AudioStreamMP3.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/minimp3/doc_classes/AudioStreamMP3.xml. .. _class_AudioStreamMP3: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 14e5cc899..859b0e959 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml. .. _class_AudioStreamOGGVorbis: diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 8eaa91d7e..cd783e2dd 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamPlayback.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamPlayback.xml. .. _class_AudioStreamPlayback: diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 21a117bc4..7690b8a27 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamPlaybackResampled.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamPlaybackResampled.xml. .. _class_AudioStreamPlaybackResampled: diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 068d833ff..74bf18d52 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamPlayer.xml. .. _class_AudioStreamPlayer: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 7822095c8..22859de64 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamPlayer2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamPlayer2D.xml. .. _class_AudioStreamPlayer2D: diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 3e25ff079..f2340dcfc 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamPlayer3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamPlayer3D.xml. .. _class_AudioStreamPlayer3D: diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 4f0f18c53..4e1621bd7 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamRandomPitch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamRandomPitch.xml. .. _class_AudioStreamRandomPitch: diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index b5f9368b1..3867d8123 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioStreamSample.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioStreamSample.xml. .. _class_AudioStreamSample: diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 17efc81e7..2f217ab52 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BackBufferCopy.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BackBufferCopy.xml. .. _class_BackBufferCopy: diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index 373d03a26..93eb496d4 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BakedLightmap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BakedLightmap.xml. .. _class_BakedLightmap: diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index 25e7b3a82..d54258bb0 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BakedLightmapData.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BakedLightmapData.xml. .. _class_BakedLightmapData: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 9da2f8673..857b6eda7 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BaseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BaseButton.xml. .. _class_BaseButton: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index de428ff93..bb6fec5a1 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Basis.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Basis.xml. .. _class_Basis: diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 1a81cefd9..f263f46d9 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BitMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BitMap.xml. .. _class_BitMap: diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 6170f7a1a..481f5a077 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BitmapFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BitmapFont.xml. .. _class_BitmapFont: diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 0eb7b36e1..3483912c4 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Bone2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Bone2D.xml. .. _class_Bone2D: @@ -111,7 +111,7 @@ Method Descriptions void **apply_rest** **(** **)** -Stores the node's current transforms in :ref:`rest`. +Resets the bone to the rest pose. This is equivalent to setting :ref:`Node2D.transform` to :ref:`rest`. .. rst-class:: classref-item-separator diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index fcd7247b7..a37676797 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BoneAttachment.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BoneAttachment.xml. .. _class_BoneAttachment: diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 99297964a..fe3472411 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/bool.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/bool.xml. .. _class_bool: diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 73b17e5a5..7218becbd 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BoxContainer.xml. .. _class_BoxContainer: diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index fb27e5be1..6124c039c 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BoxShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/BoxShape.xml. .. _class_BoxShape: diff --git a/classes/class_button.rst b/classes/class_button.rst index eedb73a8f..49bad5ad4 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Button.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Button.xml. .. _class_Button: diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index c501569ed..519b75d4b 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ButtonGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ButtonGroup.xml. .. _class_ButtonGroup: diff --git a/classes/class_callbacktweener.rst b/classes/class_callbacktweener.rst index a972ce607..e19de34e6 100644 --- a/classes/class_callbacktweener.rst +++ b/classes/class_callbacktweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CallbackTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CallbackTweener.xml. .. _class_CallbackTweener: diff --git a/classes/class_camera.rst b/classes/class_camera.rst index df5d5d3f2..0b8bc0b28 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Camera.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Camera.xml. .. _class_Camera: @@ -38,6 +38,8 @@ Properties .. table:: :widths: auto + +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ + | :ref:`bool` | :ref:`affect_lod` | ``true`` | +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ @@ -216,6 +218,27 @@ Simulate `Doppler effect `__ by tr Property Descriptions --------------------- +.. _class_Camera_property_affect_lod: + +.. rst-class:: classref-property + +:ref:`bool` **affect_lod** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_affect_lod** **(** :ref:`bool` value **)** +- :ref:`bool` **get_affect_lod** **(** **)** + +If ``true``, the camera will be used to calculate the level of detail in :ref:`LOD` nodes. + +Objects further from the camera will select lower levels of detail than those closer to the camera. + +\ **Note:** This property has no effect if :ref:`projection` is set to :ref:`PROJECTION_ORTHOGONAL`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera_property_cull_mask: .. rst-class:: classref-property diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index c80472678..a211c7e19 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Camera2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Camera2D.xml. .. _class_Camera2D: diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 79123ea64..4ccdf3a79 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CameraFeed.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CameraFeed.xml. .. _class_CameraFeed: diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index 0c65073d0..79e5f3f01 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CameraServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CameraServer.xml. .. _class_CameraServer: diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 44f644ad2..b96809dc8 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CameraTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CameraTexture.xml. .. _class_CameraTexture: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 271b07c38..6cf901530 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CanvasItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CanvasItem.xml. .. _class_CanvasItem: @@ -481,7 +481,7 @@ If ``true``, the parent **CanvasItem**'s :ref:`material` value **)** - :ref:`bool` **is_visible** **(** **)** -If ``true``, this **CanvasItem** is drawn. The node is only visible if all of its antecedents are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). +If ``true``, this **CanvasItem** is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). \ **Note:** For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. @@ -996,7 +996,7 @@ Returns ``true`` if global transform notifications are communicated to children. :ref:`bool` **is_visible_in_tree** **(** **)** |const| -Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree, and is consequently not drawn (see :ref:`_draw`). +Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is consequently not drawn (see :ref:`_draw`). .. rst-class:: classref-item-separator diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 3218f0de9..0edee0764 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CanvasItemMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CanvasItemMaterial.xml. .. _class_CanvasItemMaterial: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 4c1037655..c84b456b0 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CanvasLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CanvasLayer.xml. .. _class_CanvasLayer: @@ -172,7 +172,7 @@ Scales the layer when using :ref:`follow_viewport_enable` value **)** - :ref:`int` **get_layer** **(** **)** -Layer index for draw order. Lower values are drawn first. +Layer index for draw order. Lower values are drawn behind higher values. .. rst-class:: classref-item-separator diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index 9b822c24c..3fef7c8cd 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CanvasModulate.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CanvasModulate.xml. .. _class_CanvasModulate: diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index fb395d82b..5ebef3850 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CapsuleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CapsuleMesh.xml. .. _class_CapsuleMesh: diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 0f06c1c1e..e2b426677 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CapsuleShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CapsuleShape.xml. .. _class_CapsuleShape: diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index ff95361e4..01e208847 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CapsuleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CapsuleShape2D.xml. .. _class_CapsuleShape2D: diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 18fcbc31a..c178295eb 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CenterContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CenterContainer.xml. .. _class_CenterContainer: diff --git a/classes/class_charfxtransform.rst b/classes/class_charfxtransform.rst index 718d99bb7..e00496f1a 100644 --- a/classes/class_charfxtransform.rst +++ b/classes/class_charfxtransform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CharFXTransform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CharFXTransform.xml. .. _class_CharFXTransform: diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 65f85a8be..bf5e71b4c 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CheckBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CheckBox.xml. .. _class_CheckBox: diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index b9eec3442..b428550e0 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CheckButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CheckButton.xml. .. _class_CheckButton: diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 11f731c61..0d1c1fbb1 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CircleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CircleShape2D.xml. .. _class_CircleShape2D: diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 70287bc94..329bdf858 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ClassDB.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ClassDB.xml. .. _class_ClassDB: diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index d709881bf..a8fa60a82 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ClippedCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ClippedCamera.xml. .. _class_ClippedCamera: diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 848b8737d..350875981 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionObject.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionObject.xml. .. _class_CollisionObject: @@ -23,6 +23,8 @@ Description CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner_*`` methods. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index ad16c4f66..f31f39965 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionObject2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionObject2D.xml. .. _class_CollisionObject2D: diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 2e5c91a7e..8480201db 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionPolygon.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionPolygon.xml. .. _class_CollisionPolygon: @@ -21,6 +21,8 @@ Description Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at run-time. Creates a :ref:`Shape` for gameplay. Properties modified during gameplay will have no effect. +\ **Warning:** A non-uniformly scaled CollisionPolygon3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change its :ref:`polygon`'s vertices instead. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 8bfaa51a6..bc1672f4c 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionPolygon2D.xml. .. _class_CollisionPolygon2D: diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 4a87d5132..3cf596ef7 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionShape.xml. .. _class_CollisionShape: @@ -23,6 +23,8 @@ Editor facility for creating and editing collision shapes in 3D space. Set the : You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. +\ **Warning:** A non-uniformly scaled CollisionShape3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size of its :ref:`shape` resource instead. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index cad9278cf..994fdb52b 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CollisionShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionShape2D.xml. .. _class_CollisionShape2D: diff --git a/classes/class_color.rst b/classes/class_color.rst index 19765d8b7..2b3840254 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Color.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Color.xml. .. _class_Color: diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 0ea66ee36..7e3e7ddf3 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ColorPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorPicker.xml. .. _class_ColorPicker: diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index fec7d7acf..f32f5f7a1 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ColorPickerButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorPickerButton.xml. .. _class_ColorPickerButton: diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 50789b86b..a68a7a3bf 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ColorRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ColorRect.xml. .. _class_ColorRect: diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index a59221d8d..e051c683b 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConcavePolygonShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConcavePolygonShape.xml. .. _class_ConcavePolygonShape: diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 48ac2755a..fa1e7be52 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConcavePolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConcavePolygonShape2D.xml. .. _class_ConcavePolygonShape2D: diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index ab42f5d6f..ea114493a 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConeTwistJoint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConeTwistJoint.xml. .. _class_ConeTwistJoint: diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index d7e29b7e1..cacaec638 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConfigFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConfigFile.xml. .. _class_ConfigFile: diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 667b2af18..7fabe8a01 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConfirmationDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConfirmationDialog.xml. .. _class_ConfirmationDialog: diff --git a/classes/class_container.rst b/classes/class_container.rst index f9a1257a2..919754088 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Container.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Container.xml. .. _class_Container: diff --git a/classes/class_control.rst b/classes/class_control.rst index 6dbf136c5..afa9f3f89 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Control.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Control.xml. .. _class_Control: @@ -58,75 +58,77 @@ Properties .. table:: :widths: auto - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`anchor_bottom` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`anchor_left` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`anchor_right` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`anchor_top` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_neighbour_bottom` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_neighbour_left` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_neighbour_right` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_neighbour_top` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`String` | :ref:`hint_tooltip` | ``""`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`input_pass_on_modal_close_click` | ``true`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`margin_bottom` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`margin_left` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`margin_right` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`margin_top` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`rect_clip_content` | ``false`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_global_position` | | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_min_size` | ``Vector2( 0, 0 )`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_pivot_offset` | ``Vector2( 0, 0 )`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_position` | ``Vector2( 0, 0 )`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`rect_rotation` | ``0.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_scale` | ``Vector2( 1, 1 )`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`rect_size` | ``Vector2( 0, 0 )`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`int` | :ref:`size_flags_horizontal` | ``1`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`int` | :ref:`size_flags_vertical` | ``1`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`Theme` | :ref:`theme` | | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ - | :ref:`String` | :ref:`theme_type_variation` | ``""`` | - +--------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------+ + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_bottom` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_left` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_right` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anchor_top` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbour_bottom` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbour_left` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbour_right` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_neighbour_top` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`hint_tooltip` | ``""`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_pass_on_modal_close_click` | ``true`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`margin_bottom` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`margin_left` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`margin_right` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`margin_top` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``1`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rect_clip_content` | ``false`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_global_position` | | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_min_size` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_pivot_offset` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_position` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rect_rotation` | ``0.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_scale` | ``Vector2( 1, 1 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`rect_size` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size_flags_horizontal` | ``1`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`size_flags_vertical` | ``1`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Theme` | :ref:`theme` | | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`theme_type_variation` | ``""`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 52d7b818c..af7b0b393 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConvexPolygonShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConvexPolygonShape.xml. .. _class_ConvexPolygonShape: diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 7f48bd6b6..6e40d490c 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ConvexPolygonShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConvexPolygonShape2D.xml. .. _class_ConvexPolygonShape2D: diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index e31151d73..be9e042eb 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CPUParticles.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CPUParticles.xml. .. _class_CPUParticles: @@ -707,7 +707,9 @@ Animation speed randomness ratio. - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** -Each particle's initial color. To have particle display color in a :ref:`SpatialMaterial` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo` to ``true``. +Each particle's initial color. + +\ **Note:** :ref:`color` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color` will have no visible effect. .. rst-class:: classref-item-separator @@ -726,6 +728,8 @@ Each particle's initial color. To have particle display color in a :ref:`Spatial Each particle's initial color will vary along this :ref:`GradientTexture` (multiplied with :ref:`color`). +\ **Note:** :ref:`color_initial_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp` will have no visible effect. + .. rst-class:: classref-item-separator ---- @@ -743,6 +747,8 @@ Each particle's initial color will vary along this :ref:`GradientTexture` over its lifetime (multiplied with :ref:`color`). +\ **Note:** :ref:`color_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp` will have no visible effect. + .. rst-class:: classref-item-separator ---- @@ -862,6 +868,8 @@ The rectangle's extents if :ref:`emission_shape`\ s to modulate particles by when using :ref:`EMISSION_SHAPE_POINTS` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS`. +\ **Note:** :ref:`emission_colors` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_colors` will have no visible effect. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index ad3c490ad..c58a180f8 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CPUParticles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CPUParticles2D.xml. .. _class_CPUParticles2D: @@ -40,133 +40,135 @@ Properties .. table:: :widths: auto - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`amount` | ``8`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`angle` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`angle_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`angle_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`angular_velocity` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`angular_velocity_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`angular_velocity_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`anim_offset` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`anim_offset_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`anim_offset_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`anim_speed` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`anim_speed_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`anim_speed_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Gradient` | :ref:`color_initial_ramp` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Gradient` | :ref:`color_ramp` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`damping` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`damping_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`damping_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector2` | :ref:`direction` | ``Vector2( 1, 0 )`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`PoolColorArray` | :ref:`emission_colors` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`PoolVector2Array` | :ref:`emission_normals` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`PoolVector2Array` | :ref:`emission_points` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector2` | :ref:`emission_rect_extents` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`emission_sphere_radius` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`emitting` | ``true`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`explosiveness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`fixed_fps` | ``0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flag_align_y` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`fract_delta` | ``true`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector2` | :ref:`gravity` | ``Vector2( 0, 98 )`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`hue_variation` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`hue_variation_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`hue_variation_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`initial_velocity` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`initial_velocity_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`lifetime` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`linear_accel` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`linear_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`linear_accel_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`local_coords` | ``true`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`normalmap` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`one_shot` | ``false`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`orbit_velocity` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`orbit_velocity_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`orbit_velocity_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`preprocess` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`radial_accel` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`radial_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`radial_accel_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`randomness` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`scale_amount` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`scale_amount_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`scale_amount_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`speed_scale` | ``1.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`spread` | ``45.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`tangential_accel` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Curve` | :ref:`tangential_accel_curve` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`tangential_accel_random` | ``0.0`` | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`texture` | | - +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`amount` | ``8`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`angle_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angle_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angular_velocity` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`angular_velocity_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`angular_velocity_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anim_offset` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`anim_offset_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anim_offset_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anim_speed` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`anim_speed_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`anim_speed_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Gradient` | :ref:`color_initial_ramp` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Gradient` | :ref:`color_ramp` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`damping` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`damping_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`damping_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`direction` | ``Vector2( 1, 0 )`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PoolColorArray` | :ref:`emission_colors` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PoolVector2Array` | :ref:`emission_normals` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PoolVector2Array` | :ref:`emission_points` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`emission_rect_extents` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`emission_sphere_radius` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`emitting` | ``true`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`explosiveness` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`fixed_fps` | ``0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`flag_align_y` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`fract_delta` | ``true`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`gravity` | ``Vector2( 0, 98 )`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`hue_variation` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`hue_variation_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`hue_variation_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`initial_velocity` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`initial_velocity_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lifetime` | ``1.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`lifetime_randomness` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`linear_accel` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`linear_accel_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`linear_accel_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`local_coords` | ``true`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Texture` | :ref:`normalmap` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`one_shot` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`orbit_velocity` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`orbit_velocity_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`orbit_velocity_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``1`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`preprocess` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`radial_accel` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`radial_accel_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`radial_accel_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`randomness` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scale_amount` | ``1.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`scale_amount_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`scale_amount_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`speed_scale` | ``1.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`spread` | ``45.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tangential_accel` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Curve` | :ref:`tangential_accel_curve` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`tangential_accel_random` | ``0.0`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Texture` | :ref:`texture` | | + +---------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index 693347902..b16a3f8e6 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Crypto.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Crypto.xml. .. _class_Crypto: diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 272748d1e..15a874f05 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CryptoKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CryptoKey.xml. .. _class_CryptoKey: diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 67909cce6..c76839204 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGBox.xml. .. _class_CSGBox: diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index a07e6cb59..08c7a8b09 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGCombiner.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGCombiner.xml. .. _class_CSGCombiner: diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index c756108e7..6dcae1dcc 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGCylinder.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGCylinder.xml. .. _class_CSGCylinder: diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 97765e41a..c3ac01e02 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGMesh.xml. .. _class_CSGMesh: diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index b7a19f073..ad05c53ed 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGPolygon.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGPolygon.xml. .. _class_CSGPolygon: diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 0972cb512..f12026e78 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGPrimitive.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGPrimitive.xml. .. _class_CSGPrimitive: diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index a621acb8c..914b35b9a 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGShape.xml. .. _class_CSGShape: diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index 94aefeca1..bd6970d83 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGSphere.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGSphere.xml. .. _class_CSGSphere: diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index c0fef860c..6e86c5a66 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/csg/doc_classes/CSGTorus.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/csg/doc_classes/CSGTorus.xml. .. _class_CSGTorus: diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index e778cc59a..1c1806507 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/mono/doc_classes/CSharpScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/mono/doc_classes/CSharpScript.xml. .. _class_CSharpScript: diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 977346b59..df13783c0 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CubeMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CubeMap.xml. .. _class_CubeMap: diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 414afede0..06219a659 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CubeMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CubeMesh.xml. .. _class_CubeMesh: diff --git a/classes/class_cullinstance.rst b/classes/class_cullinstance.rst index 578a7a7a7..47fd92759 100644 --- a/classes/class_cullinstance.rst +++ b/classes/class_cullinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CullInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CullInstance.xml. .. _class_CullInstance: @@ -130,7 +130,9 @@ Property Descriptions This allows fine control over the mesh merging feature in the :ref:`RoomManager`. -Setting this option to ``false`` can be used to prevent an instance being merged. +Setting this option to ``false`` can be used to prevent an instance being merged. When set to ``true`` (the default), merging will be determined by :ref:`Spatial.merging_mode`. + +\ *Deprecated.* This property has been deprecated and is only included for backward compatibility. Please use :ref:`Spatial.merging_mode` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 3047beca4..fda30263a 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Curve.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Curve.xml. .. _class_Curve: diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 65ac0d870..d4eba65af 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Curve2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Curve2D.xml. .. _class_Curve2D: diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index eaefe90c0..17bfdb7d1 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Curve3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Curve3D.xml. .. _class_Curve3D: diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index ae38ab488..8497608ea 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CurveTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CurveTexture.xml. .. _class_CurveTexture: diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 2f5cf4785..29a44d3a1 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CylinderMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CylinderMesh.xml. .. _class_CylinderMesh: diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 5ef10cefd..dfc69085b 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CylinderShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CylinderShape.xml. .. _class_CylinderShape: diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 406eab19d..ad7ce2aa2 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DampedSpringJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/DampedSpringJoint2D.xml. .. _class_DampedSpringJoint2D: diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index a25e9ddb7..2bb089bd4 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Dictionary.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Dictionary.xml. .. _class_Dictionary: @@ -147,6 +147,8 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_or_add` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | + +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | @@ -247,6 +249,18 @@ Returns the current value for the specified key in the **Dictionary**. If the ke ---- +.. _class_Dictionary_method_get_or_add: + +.. rst-class:: classref-method + +:ref:`Variant` **get_or_add** **(** :ref:`Variant` key, :ref:`Variant` default=null **)** + +Gets a value and ensures the key is set. If the ``key`` exists in the dictionary, this behaves like :ref:`get`. Otherwise, the ``default`` value is inserted into the dictionary and returned. + +.. rst-class:: classref-item-separator + +---- + .. _class_Dictionary_method_has: .. rst-class:: classref-method diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 163cd983a..815e7879d 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DirectionalLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/DirectionalLight.xml. .. _class_DirectionalLight: @@ -43,9 +43,11 @@ Properties +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :ref:`ShadowDepthRange` | :ref:`directional_shadow_depth_range` | ``0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ + | :ref:`float` | :ref:`directional_shadow_fade_start` | ``0.8`` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :ref:`float` | :ref:`directional_shadow_max_distance` | ``100.0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ - | :ref:`ShadowMode` | :ref:`directional_shadow_mode` | ``2`` | + | :ref:`ShadowMode` | :ref:`directional_shadow_mode` | ``3`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :ref:`float` | :ref:`directional_shadow_normal_bias` | ``0.8`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ @@ -89,11 +91,19 @@ Renders the entire scene's shadow map from an orthogonal point of view. This is Splits the view frustum in 2 areas, each with its own shadow map. This shadow mode is a compromise between :ref:`SHADOW_ORTHOGONAL` and :ref:`SHADOW_PARALLEL_4_SPLITS` in terms of performance. +.. _class_DirectionalLight_constant_SHADOW_PARALLEL_3_SPLITS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ShadowMode` **SHADOW_PARALLEL_3_SPLITS** = ``2`` + +Splits the view frustum in 3 areas, each with its own shadow map. This shadow mode is a compromise between :ref:`SHADOW_ORTHOGONAL` and :ref:`SHADOW_PARALLEL_4_SPLITS` in terms of performance. + .. _class_DirectionalLight_constant_SHADOW_PARALLEL_4_SPLITS: .. rst-class:: classref-enumeration-constant -:ref:`ShadowMode` **SHADOW_PARALLEL_4_SPLITS** = ``2`` +:ref:`ShadowMode` **SHADOW_PARALLEL_4_SPLITS** = ``3`` Splits the view frustum in 4 areas, each with its own shadow map. This is the slowest directional shadow mode. @@ -183,6 +193,23 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang ---- +.. _class_DirectionalLight_property_directional_shadow_fade_start: + +.. rst-class:: classref-property + +:ref:`float` **directional_shadow_fade_start** = ``0.8`` + +.. rst-class:: classref-property-setget + +- void **set_param** **(** :ref:`float` value **)** +- :ref:`float` **get_param** **(** **)** + +Proportion of :ref:`directional_shadow_max_distance` at which point the shadow starts to fade. At :ref:`directional_shadow_max_distance`, the shadow will disappear. The default value is a balance between smooth fading and distant shadow visibility. If the camera moves fast and the :ref:`directional_shadow_max_distance` is low, consider lowering :ref:`directional_shadow_fade_start` below ``0.8`` to make shadow transitions less noticeable. On the other hand, if you tuned :ref:`directional_shadow_max_distance` to cover the entire scene, you can set :ref:`directional_shadow_fade_start` to ``1.0`` to prevent the shadow from fading in the distance (it will suddenly cut off instead). + +.. rst-class:: classref-item-separator + +---- + .. _class_DirectionalLight_property_directional_shadow_max_distance: .. rst-class:: classref-property @@ -204,7 +231,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** = ``3`` .. rst-class:: classref-property-setget diff --git a/classes/class_directory.rst b/classes/class_directory.rst index f610b17bd..96b114b3a 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Directory.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Directory.xml. .. _class_Directory: diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst index f27441c46..2114b2ca6 100644 --- a/classes/class_dtlsserver.rst +++ b/classes/class_dtlsserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DTLSServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/DTLSServer.xml. .. _class_DTLSServer: diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 3e0d6bf68..8080ebdda 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DynamicFont.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/DynamicFont.xml. .. _class_DynamicFont: diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 92c4c6e27..cecda1d49 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DynamicFontData.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/DynamicFontData.xml. .. _class_DynamicFontData: diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 20958b566..313fc47b3 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorExportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorExportPlugin.xml. .. _class_EditorExportPlugin: diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 074b3fa22..f4792924f 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorFeatureProfile.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorFeatureProfile.xml. .. _class_EditorFeatureProfile: diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index 6f246d2ad..7092a135f 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorFileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorFileDialog.xml. .. _class_EditorFileDialog: diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index e698b6865..d7ff9ba10 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorFileSystem.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorFileSystem.xml. .. _class_EditorFileSystem: diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index a668f16ba..60f87f6ab 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorFileSystemDirectory.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorFileSystemDirectory.xml. .. _class_EditorFileSystemDirectory: diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 45f0f6f75..42fe59d52 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorImportPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorImportPlugin.xml. .. _class_EditorImportPlugin: diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 4fa4cf423..af7db68cc 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorInspector.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorInspector.xml. .. _class_EditorInspector: @@ -49,9 +49,11 @@ Methods .. table:: :widths: auto - +------+------------------------------------------------------------------+ - | void | :ref:`refresh` **(** **)** | - +------+------------------------------------------------------------------+ + +-----------------------------+--------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`get_edited_object` **(** **)** | + +-----------------------------+--------------------------------------------------------------------------------------+ + | void | :ref:`refresh` **(** **)** | + +-----------------------------+--------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -153,6 +155,18 @@ Emitted when a property that requires a restart to be applied is edited in the i Method Descriptions ------------------- +.. _class_EditorInspector_method_get_edited_object: + +.. rst-class:: classref-method + +:ref:`Object` **get_edited_object** **(** **)** + +Returns the object currently selected in this inspector. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInspector_method_refresh: .. rst-class:: classref-method diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index 7c867bdb1..df59eea9c 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorInspectorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorInspectorPlugin.xml. .. _class_EditorInspectorPlugin: diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 7d349e18d..d14a51792 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorInterface.xml. .. _class_EditorInterface: diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 267a122ab..76b1189b5 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorPlugin.xml. .. _class_EditorPlugin: diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index f10c1f878..0bc0a4c4e 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorProperty.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorProperty.xml. .. _class_EditorProperty: diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index dc0ae465b..06b380f43 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorResourceConversionPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorResourceConversionPlugin.xml. .. _class_EditorResourceConversionPlugin: diff --git a/classes/class_editorresourcepicker.rst b/classes/class_editorresourcepicker.rst index 43785cebd..2bfa149ba 100644 --- a/classes/class_editorresourcepicker.rst +++ b/classes/class_editorresourcepicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorResourcePicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorResourcePicker.xml. .. _class_EditorResourcePicker: diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 8a35b0466..ec156be2f 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorResourcePreview.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorResourcePreview.xml. .. _class_EditorResourcePreview: diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index d95fa29dd..214ba3f56 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorResourcePreviewGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorResourcePreviewGenerator.xml. .. _class_EditorResourcePreviewGenerator: diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index 2d237eb61..d834e212a 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSceneImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSceneImporter.xml. .. _class_EditorSceneImporter: diff --git a/classes/class_editorsceneimporterfbx.rst b/classes/class_editorsceneimporterfbx.rst index b3301f2e5..519077010 100644 --- a/classes/class_editorsceneimporterfbx.rst +++ b/classes/class_editorsceneimporterfbx.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/fbx/doc_classes/EditorSceneImporterFBX.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/fbx/doc_classes/EditorSceneImporterFBX.xml. .. _class_EditorSceneImporterFBX: diff --git a/classes/class_editorsceneimportergltf.rst b/classes/class_editorsceneimportergltf.rst index 241bf6a1b..7a8a63642 100644 --- a/classes/class_editorsceneimportergltf.rst +++ b/classes/class_editorsceneimportergltf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/EditorSceneImporterGLTF.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/EditorSceneImporterGLTF.xml. .. _class_EditorSceneImporterGLTF: diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index f28a464a9..5c0d341d5 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorScenePostImport.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorScenePostImport.xml. .. _class_EditorScenePostImport: diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 427fd5a8a..2a0119f35 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorScript.xml. .. _class_EditorScript: diff --git a/classes/class_editorscriptpicker.rst b/classes/class_editorscriptpicker.rst index 712731806..6a1ce6a4a 100644 --- a/classes/class_editorscriptpicker.rst +++ b/classes/class_editorscriptpicker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorScriptPicker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorScriptPicker.xml. .. _class_EditorScriptPicker: diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 2162a9ae0..210a292b8 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSelection.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSelection.xml. .. _class_EditorSelection: diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 229915f57..8454a1fd5 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSettings.xml. .. _class_EditorSettings: @@ -258,8 +258,6 @@ Properties +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`interface/theme/custom_theme` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`interface/theme/enable_touchscreen_touch_area` | - +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/theme/highlight_tabs` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/theme/icon_and_font_color` | @@ -270,6 +268,14 @@ Properties +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/theme/use_graph_node_headers` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_long_press_as_right_click` | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`network/debug/remote_host` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/debug/remote_port` | @@ -292,6 +298,8 @@ Properties +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`run/output/font_size` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`run/window_placement/android_window` | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`run/window_placement/rect` | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`run/window_placement/rect_custom_position` | @@ -1904,20 +1912,6 @@ The custom theme resource to use for the editor. Must be a Godot theme resource ---- -.. _class_EditorSettings_property_interface/theme/enable_touchscreen_touch_area: - -.. rst-class:: classref-property - -:ref:`bool` **interface/theme/enable_touchscreen_touch_area** - -If ``true``, increases the touch area for the UI elements to improve usability on touchscreen devices. - -\ **Note:** Defaults to ``true`` on touchscreen devices. - -.. rst-class:: classref-item-separator - ----- - .. _class_EditorSettings_property_interface/theme/highlight_tabs: .. rst-class:: classref-property @@ -1984,6 +1978,62 @@ If ``true``, use colored header backgrounds for individual :ref:`GraphNode` **interface/touchscreen/enable_long_press_as_right_click** + +If ``true``, long press on touchscreen is treated as right click. + +\ **Note:** Defaults to ``true`` on touchscreen devices. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/touchscreen/enable_pan_and_scale_gestures: + +.. rst-class:: classref-property + +:ref:`bool` **interface/touchscreen/enable_pan_and_scale_gestures** + +If ``true``, enable two finger pan and scale gestures on touchscreen devices. + +\ **Note:** Defaults to ``true`` on touchscreen devices. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/touchscreen/increase_scrollbar_touch_area: + +.. rst-class:: classref-property + +:ref:`bool` **interface/touchscreen/increase_scrollbar_touch_area** + +If ``true``, increases the scrollbar touch area to improve usability on touchscreen devices. + +\ **Note:** Defaults to ``true`` on touchscreen devices. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_interface/touchscreen/scale_gizmo_handles: + +.. rst-class:: classref-property + +:ref:`float` **interface/touchscreen/scale_gizmo_handles** + +Specify the multiplier to apply to the scale for the editor gizmo handles to improve usability on touchscreen devices. + +\ **Note:** Defaults to ``1`` on non-touchscreen devices. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_network/debug/remote_host: .. rst-class:: classref-property @@ -2120,6 +2170,20 @@ The size of the font in the **Output** panel at the bottom of the editor. This s ---- +.. _class_EditorSettings_property_run/window_placement/android_window: + +.. rst-class:: classref-property + +:ref:`int` **run/window_placement/android_window** + +The Android window to display the project on when starting the project from the editor. + +\ **Note:** Only available in the Android editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_run/window_placement/rect: .. rst-class:: classref-property diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 6a729acf6..71c4ad077 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSpatialGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSpatialGizmo.xml. .. _class_EditorSpatialGizmo: diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 6b14e72c3..78443524f 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSpatialGizmoPlugin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSpatialGizmoPlugin.xml. .. _class_EditorSpatialGizmoPlugin: @@ -39,7 +39,7 @@ Methods :widths: auto +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_material` **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** | + | void | :ref:`add_material` **(** :ref:`String` name, :ref:`Material3D` material **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_be_hidden` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,7 +57,7 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`EditorSpatialGizmo` gizmo, :ref:`int` index **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`SpatialMaterial` | :ref:`get_material` **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo=null **)** | + | :ref:`Material3D` | :ref:`get_material` **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo=null **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** |virtual| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -87,7 +87,7 @@ Method Descriptions .. rst-class:: classref-method -void **add_material** **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** +void **add_material** **(** :ref:`String` name, :ref:`Material3D` material **)** 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. @@ -197,7 +197,7 @@ Gets actual value of a handle from gizmo. Called for this plugin's active gizmos .. rst-class:: classref-method -:ref:`SpatialMaterial` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo=null **)** +:ref:`Material3D` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo=null **)** Gets material from the internal list of materials. If an :ref:`EditorSpatialGizmo` is provided, it will try to get the corresponding variant (selected and/or editable). diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index 5db8e3f84..535a45f54 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorSpinSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorSpinSlider.xml. .. _class_EditorSpinSlider: diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index a4caee92d..08a9f9e1a 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EditorVCSInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EditorVCSInterface.xml. .. _class_EditorVCSInterface: diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index c0826e59d..bea82de62 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/EncodedObjectAsID.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/EncodedObjectAsID.xml. .. _class_EncodedObjectAsID: diff --git a/classes/class_engine.rst b/classes/class_engine.rst index b1bbcec57..8f7aa4dbf 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Engine.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Engine.xml. .. _class_Engine: @@ -207,7 +207,7 @@ The desired frames per second. If the hardware cannot keep up, this setting may - void **set_time_scale** **(** :ref:`float` value **)** - :ref:`float` **get_time_scale** **(** **)** -Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. +Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. This also affects :ref:`Timer` and :ref:`SceneTreeTimer` (see :ref:`SceneTree.create_timer` for how to control this). .. rst-class:: classref-section-separator diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 8b87f76d5..797ab72bd 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Environment.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Environment.xml. .. _class_Environment: diff --git a/classes/class_expression.rst b/classes/class_expression.rst index df9ccf645..8a1b8b102 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Expression.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Expression.xml. .. _class_Expression: diff --git a/classes/class_externaltexture.rst b/classes/class_externaltexture.rst index a22045fcb..fc99ea14c 100644 --- a/classes/class_externaltexture.rst +++ b/classes/class_externaltexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ExternalTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ExternalTexture.xml. .. _class_ExternalTexture: diff --git a/classes/class_file.rst b/classes/class_file.rst index a73756be2..dede517d6 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/File.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/File.xml. .. _class_File: diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index ba2366b0b..b9bd63f0d 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/FileDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/FileDialog.xml. .. _class_FileDialog: diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index d457e7d50..670085f73 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/FileSystemDock.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/FileSystemDock.xml. .. _class_FileSystemDock: diff --git a/classes/class_float.rst b/classes/class_float.rst index 8984b58bc..e5f1c2197 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/float.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/float.xml. .. _class_float: diff --git a/classes/class_flowcontainer.rst b/classes/class_flowcontainer.rst index a648cbcba..c54226cfa 100644 --- a/classes/class_flowcontainer.rst +++ b/classes/class_flowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/FlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/FlowContainer.xml. .. _class_FlowContainer: diff --git a/classes/class_font.rst b/classes/class_font.rst index 8adf696e8..0d10861dd 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Font.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Font.xml. .. _class_Font: diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index c24dc9f59..f8a82d33e 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/FuncRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/FuncRef.xml. .. _class_FuncRef: diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index f7d25b9cf..0a51507cf 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/GDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/GDNative.xml. .. _class_GDNative: diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index cf2d1b8fb..e196ecee6 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/GDNativeLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/GDNativeLibrary.xml. .. _class_GDNativeLibrary: diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index b2258d928..587d32485 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdscript/doc_classes/GDScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdscript/doc_classes/GDScript.xml. .. _class_GDScript: diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 18e706bf3..c99071ff7 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdscript/doc_classes/GDScriptFunctionState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdscript/doc_classes/GDScriptFunctionState.xml. .. _class_GDScriptFunctionState: diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 7ebc801c8..314b26ebd 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Generic6DOFJoint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Generic6DOFJoint.xml. .. _class_Generic6DOFJoint: diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index fd1d1e9ae..181d8b0f4 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Geometry.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Geometry.xml. .. _class_Geometry: diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 9520121aa..2673eff0b 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GeometryInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GeometryInstance.xml. .. _class_GeometryInstance: @@ -40,14 +40,6 @@ Properties +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`LightmapScale` | :ref:`lightmap_scale` | ``0`` | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lod_max_distance` | ``0.0`` | - +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lod_max_hysteresis` | ``0.0`` | - +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lod_min_distance` | ``0.0`` | - +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`lod_min_hysteresis` | ``0.0`` | - +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`Material` | :ref:`material_overlay` | | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`Material` | :ref:`material_override` | | @@ -285,82 +277,6 @@ Scale factor for the generated baked lightmap. Useful for adding detail to certa ---- -.. _class_GeometryInstance_property_lod_max_distance: - -.. rst-class:: classref-property - -:ref:`float` **lod_max_distance** = ``0.0`` - -.. rst-class:: classref-property-setget - -- void **set_lod_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_max_distance** **(** **)** - -The GeometryInstance's max LOD distance. - -\ **Note:** This property currently has no effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_GeometryInstance_property_lod_max_hysteresis: - -.. rst-class:: classref-property - -:ref:`float` **lod_max_hysteresis** = ``0.0`` - -.. rst-class:: classref-property-setget - -- void **set_lod_max_hysteresis** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_max_hysteresis** **(** **)** - -The GeometryInstance's max LOD margin. - -\ **Note:** This property currently has no effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_GeometryInstance_property_lod_min_distance: - -.. rst-class:: classref-property - -:ref:`float` **lod_min_distance** = ``0.0`` - -.. rst-class:: classref-property-setget - -- void **set_lod_min_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_min_distance** **(** **)** - -The GeometryInstance's min LOD distance. - -\ **Note:** This property currently has no effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_GeometryInstance_property_lod_min_hysteresis: - -.. rst-class:: classref-property - -:ref:`float` **lod_min_hysteresis** = ``0.0`` - -.. rst-class:: classref-property-setget - -- void **set_lod_min_hysteresis** **(** :ref:`float` value **)** -- :ref:`float` **get_lod_min_hysteresis** **(** **)** - -The GeometryInstance's min LOD margin. - -\ **Note:** This property currently has no effect. - -.. rst-class:: classref-item-separator - ----- - .. _class_GeometryInstance_property_material_overlay: .. rst-class:: classref-property diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 6a59b0c0b..3c356d8d5 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GIProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GIProbe.xml. .. _class_GIProbe: diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index bb109a5bd..451fc7961 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GIProbeData.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GIProbeData.xml. .. _class_GIProbeData: diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 0e124863e..8dff6cb22 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFAccessor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFAccessor.xml. .. _class_GLTFAccessor: diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 0d5d2197d..537fd8112 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFAnimation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFAnimation.xml. .. _class_GLTFAnimation: diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index 8d44993ad..3dbbe7c76 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFBufferView.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFBufferView.xml. .. _class_GLTFBufferView: diff --git a/classes/class_gltfcamera.rst b/classes/class_gltfcamera.rst index 579534e8f..5befd39ab 100644 --- a/classes/class_gltfcamera.rst +++ b/classes/class_gltfcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFCamera.xml. .. _class_GLTFCamera: diff --git a/classes/class_gltfcollider.rst b/classes/class_gltfcollider.rst new file mode 100644 index 000000000..d41f9feb7 --- /dev/null +++ b/classes/class_gltfcollider.rst @@ -0,0 +1,227 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFCollider.xml. + +.. _class_GLTFCollider: + +GLTFCollider +============ + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +Represents a GLTF collider. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Represents a collider as defined by the ``OMI_collider`` GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `OMI_collider GLTF extension `__ + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`ArrayMesh` | :ref:`array_mesh` | | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`height` | ``2.0`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`bool` | :ref:`is_trigger` | ``false`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`int` | :ref:`mesh_index` | ``-1`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`radius` | ``0.5`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`shape_type` | ``""`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + | :ref:`Vector3` | :ref:`size` | ``Vector3( 1, 1, 1 )`` | + +-----------------------------------+-----------------------------------------------------------+------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +---------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`CollisionShape` | :ref:`to_node` **(** :ref:`bool` cache_shapes=false **)** | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_GLTFCollider_property_array_mesh: + +.. rst-class:: classref-property + +:ref:`ArrayMesh` **array_mesh** + +.. rst-class:: classref-property-setget + +- void **set_array_mesh** **(** :ref:`ArrayMesh` value **)** +- :ref:`ArrayMesh` **get_array_mesh** **(** **)** + +The :ref:`ArrayMesh` resource of the collider. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh). + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_height: + +.. rst-class:: classref-property + +:ref:`float` **height** = ``2.0`` + +.. rst-class:: classref-property-setget + +- void **set_height** **(** :ref:`float` value **)** +- :ref:`float` **get_height** **(** **)** + +The height of the collider, in meters. This is only used when the collider type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_is_trigger: + +.. rst-class:: classref-property + +:ref:`bool` **is_trigger** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_is_trigger** **(** :ref:`bool` value **)** +- :ref:`bool` **get_is_trigger** **(** **)** + +If ``true``, indicates that this collider is a trigger. For Godot, this means that the collider should be a child of an Area3D node. + +This is the only variable not used in the :ref:`to_node` method, it's intended to be used alongside when deciding where to add the generated node as a child. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_mesh_index: + +.. rst-class:: classref-property + +:ref:`int` **mesh_index** = ``-1`` + +.. rst-class:: classref-property-setget + +- void **set_mesh_index** **(** :ref:`int` value **)** +- :ref:`int` **get_mesh_index** **(** **)** + +The index of the collider's mesh in the GLTF file. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh). + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_radius: + +.. rst-class:: classref-property + +:ref:`float` **radius** = ``0.5`` + +.. rst-class:: classref-property-setget + +- void **set_radius** **(** :ref:`float` value **)** +- :ref:`float` **get_radius** **(** **)** + +The radius of the collider, in meters. This is only used when the collider type is "capsule", "cylinder", or "sphere". This value should not be negative. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_shape_type: + +.. rst-class:: classref-property + +:ref:`String` **shape_type** = ``""`` + +.. rst-class:: classref-property-setget + +- void **set_shape_type** **(** :ref:`String` value **)** +- :ref:`String` **get_shape_type** **(** **)** + +The type of shape this collider represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_property_size: + +.. rst-class:: classref-property + +:ref:`Vector3` **size** = ``Vector3( 1, 1, 1 )`` + +.. rst-class:: classref-property-setget + +- void **set_size** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_size** **(** **)** + +The size of the collider, in meters. This is only used when the collider type is "box", and it represents the "diameter" of the box. This value should not be negative. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFCollider_method_to_dictionary: + +.. rst-class:: classref-method + +:ref:`Dictionary` **to_dictionary** **(** **)** |const| + +Serializes this GLTFCollider instance into a :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFCollider_method_to_node: + +.. rst-class:: classref-method + +:ref:`CollisionShape` **to_node** **(** :ref:`bool` cache_shapes=false **)** + +Converts this GLTFCollider instance into a Godot :ref:`CollisionShape` node. + +.. |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.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index 52f21c4a7..4d2891ddc 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFDocument.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFDocument.xml. .. _class_GLTFDocument: diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index bf06d16d1..31423de36 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFDocumentExtension.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFDocumentExtension.xml. .. _class_GLTFDocumentExtension: @@ -31,29 +31,29 @@ Methods .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_convert_scene_node` **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Object` scene_node **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_export_node` **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` json, :ref:`Object` node **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_export_post` **(** :ref:`Object` state **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_export_preflight` **(** :ref:`Object` state, :ref:`Object` root **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Object` | :ref:`_generate_scene_node` **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Object` scene_parent **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`_get_supported_extensions` **(** **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_import_node` **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` json, :ref:`Object` node **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_import_post` **(** :ref:`Object` state, :ref:`Object` root **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_import_post_parse` **(** :ref:`Object` state **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_import_preflight` **(** :ref:`Object` state, :ref:`PoolStringArray` extensions **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_parse_node_extensions` **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` extensions **)** |virtual| | - +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_convert_scene_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_node **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_export_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_export_post` **(** :ref:`GLTFState` state **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_export_preflight` **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Object` | :ref:`_generate_scene_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_parent **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`_get_supported_extensions` **(** **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_import_node` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_import_post` **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_import_post_parse` **(** :ref:`GLTFState` state **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_import_preflight` **(** :ref:`GLTFState` state, :ref:`PoolStringArray` extensions **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_parse_node_extensions` **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` extensions **)** |virtual| | + +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -68,7 +68,7 @@ Method Descriptions .. rst-class:: classref-method -void **_convert_scene_node** **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Object` scene_node **)** |virtual| +void **_convert_scene_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_node **)** |virtual| Part of the export process. This method is run after :ref:`_export_preflight` and before :ref:`_export_node`. @@ -82,7 +82,7 @@ Runs when converting the data from a Godot scene node. This method can be used t .. rst-class:: classref-method -:ref:`int` **_export_node** **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` json, :ref:`Object` node **)** |virtual| +:ref:`int` **_export_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| Part of the export process. This method is run after :ref:`_convert_scene_node` and before :ref:`_export_post`. @@ -96,7 +96,7 @@ This method can be used to modify the final JSON of each node. .. rst-class:: classref-method -:ref:`int` **_export_post** **(** :ref:`Object` state **)** |virtual| +:ref:`int` **_export_post** **(** :ref:`GLTFState` state **)** |virtual| Part of the export process. This method is run last, after all other parts of the export process. @@ -110,7 +110,7 @@ This method can be used to modify the final JSON of the generated GLTF file. .. rst-class:: classref-method -:ref:`int` **_export_preflight** **(** :ref:`Object` state, :ref:`Object` root **)** |virtual| +:ref:`int` **_export_preflight** **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| Part of the export process. This method is run first, before all other parts of the export process. @@ -124,7 +124,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`Object` **_generate_scene_node** **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Object` scene_parent **)** |virtual| +:ref:`Object` **_generate_scene_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Node` scene_parent **)** |virtual| Part of the import process. This method is run after :ref:`_parse_node_extensions` and before :ref:`_import_post_parse`. @@ -152,7 +152,7 @@ Returns an array of the GLTF extensions supported by this GLTFDocumentExtension .. rst-class:: classref-method -:ref:`int` **_import_node** **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` json, :ref:`Object` node **)** |virtual| +:ref:`int` **_import_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| Part of the import process. This method is run after :ref:`_import_post_parse` and before :ref:`_import_post`. @@ -166,7 +166,7 @@ This method can be used to make modifications to each of the generated Godot sce .. rst-class:: classref-method -:ref:`int` **_import_post** **(** :ref:`Object` state, :ref:`Object` root **)** |virtual| +:ref:`int` **_import_post** **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| Part of the import process. This method is run last, after all other parts of the import process. @@ -180,7 +180,7 @@ This method can be used to modify the final Godot scene generated by the import .. rst-class:: classref-method -:ref:`int` **_import_post_parse** **(** :ref:`Object` state **)** |virtual| +:ref:`int` **_import_post_parse** **(** :ref:`GLTFState` state **)** |virtual| Part of the import process. This method is run after :ref:`_generate_scene_node` and before :ref:`_import_node`. @@ -194,7 +194,7 @@ This method can be used to modify any of the data imported so far, including any .. rst-class:: classref-method -:ref:`int` **_import_preflight** **(** :ref:`Object` state, :ref:`PoolStringArray` extensions **)** |virtual| +:ref:`int` **_import_preflight** **(** :ref:`GLTFState` state, :ref:`PoolStringArray` extensions **)** |virtual| Part of the import process. This method is run first, before all other parts of the import process. @@ -208,7 +208,7 @@ The return value is used to determine if this **GLTFDocumentExtension** instance .. rst-class:: classref-method -:ref:`int` **_parse_node_extensions** **(** :ref:`Object` state, :ref:`Object` gltf_node, :ref:`Dictionary` extensions **)** |virtual| +:ref:`int` **_parse_node_extensions** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` extensions **)** |virtual| Part of the import process. This method is run after :ref:`_get_supported_extensions` and before :ref:`_generate_scene_node`. diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index b2f0f6699..34df484e8 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFLight.xml. .. _class_GLTFLight: diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 20801aad2..0dc33afff 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFMesh.xml. .. _class_GLTFMesh: diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 5378b1646..fd5b73aa6 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFNode.xml. .. _class_GLTFNode: @@ -100,9 +100,7 @@ Property Descriptions - void **set_camera** **(** :ref:`int` value **)** - :ref:`int` **get_camera** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a camera, the index of the :ref:`GLTFCamera` in the :ref:`GLTFState` that describes the camera's properties. If -1, this node is not a camera. .. rst-class:: classref-item-separator @@ -119,9 +117,7 @@ Property Descriptions - void **set_children** **(** :ref:`PoolIntArray` value **)** - :ref:`PoolIntArray` **get_children** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The indices of the children nodes in the :ref:`GLTFState`. If this GLTF node has no children, this will be an empty array. .. rst-class:: classref-item-separator @@ -138,9 +134,7 @@ Property Descriptions - void **set_height** **(** :ref:`int` value **)** - :ref:`int` **get_height** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +How deep into the node hierarchy this node is. A root node will have a height of 0, its children will have a height of 1, and so on. If -1, the height has not been calculated. .. rst-class:: classref-item-separator @@ -157,9 +151,7 @@ Property Descriptions - void **set_joint** **(** :ref:`bool` value **)** - :ref:`bool` **get_joint** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +This property is unused and does nothing. .. rst-class:: classref-item-separator @@ -176,9 +168,7 @@ Property Descriptions - void **set_light** **(** :ref:`int` value **)** - :ref:`int` **get_light** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a light, the index of the :ref:`GLTFLight` in the :ref:`GLTFState` that describes the light's properties. If -1, this node is not a light. .. rst-class:: classref-item-separator @@ -195,9 +185,7 @@ Property Descriptions - void **set_mesh** **(** :ref:`int` value **)** - :ref:`int` **get_mesh** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node is a mesh, the index of the :ref:`GLTFMesh` in the :ref:`GLTFState` that describes the mesh's properties. If -1, this node is not a mesh. .. rst-class:: classref-item-separator @@ -214,9 +202,7 @@ Property Descriptions - void **set_parent** **(** :ref:`int` value **)** - :ref:`int` **get_parent** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The index of the parent node in the :ref:`GLTFState`. If -1, this node is a root node. .. rst-class:: classref-item-separator @@ -233,9 +219,7 @@ Property Descriptions - void **set_rotation** **(** :ref:`Quat` value **)** - :ref:`Quat` **get_rotation** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The rotation of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -252,9 +236,7 @@ Property Descriptions - void **set_scale** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_scale** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The scale of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -271,9 +253,7 @@ Property Descriptions - void **set_skeleton** **(** :ref:`int` value **)** - :ref:`int` **get_skeleton** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node has a skeleton, the index of the :ref:`GLTFSkeleton` in the :ref:`GLTFState` that describes the skeleton's properties. If -1, this node does not have a skeleton. .. rst-class:: classref-item-separator @@ -290,9 +270,7 @@ Property Descriptions - void **set_skin** **(** :ref:`int` value **)** - :ref:`int` **get_skin** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +If this GLTF node has a skin, the index of the :ref:`GLTFSkin` in the :ref:`GLTFState` that describes the skin's properties. If -1, this node does not have a skin. .. rst-class:: classref-item-separator @@ -309,9 +287,7 @@ Property Descriptions - void **set_translation** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_translation** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The position of the GLTF node relative to its parent. .. rst-class:: classref-item-separator @@ -328,9 +304,7 @@ Property Descriptions - void **set_xform** **(** :ref:`Transform` value **)** - :ref:`Transform` **get_xform** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The transform of the GLTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred. .. rst-class:: classref-section-separator diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst new file mode 100644 index 000000000..c9e4e6722 --- /dev/null +++ b/classes/class_gltfphysicsbody.rst @@ -0,0 +1,168 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFPhysicsBody.xml. + +.. _class_GLTFPhysicsBody: + +GLTFPhysicsBody +=============== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +Represents a GLTF physics body. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Represents a physics body as defined by the ``OMI_physics_body`` GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future. + +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `OMI_physics_body GLTF extension `__ + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------+--------------------------------------------------------------------------+------------------------+ + | :ref:`Vector3` | :ref:`angular_velocity` | ``Vector3( 0, 0, 0 )`` | + +-------------------------------+--------------------------------------------------------------------------+------------------------+ + | :ref:`String` | :ref:`body_type` | ``"static"`` | + +-------------------------------+--------------------------------------------------------------------------+------------------------+ + | :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3( 0, 0, 0 )`` | + +-------------------------------+--------------------------------------------------------------------------+------------------------+ + | :ref:`float` | :ref:`mass` | ``1.0`` | + +-------------------------------+--------------------------------------------------------------------------+------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------+--------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`to_dictionary` **(** **)** |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------+ + | :ref:`CollisionObject` | :ref:`to_node` **(** **)** |const| | + +-----------------------------------------------+--------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_GLTFPhysicsBody_property_angular_velocity: + +.. rst-class:: classref-property + +:ref:`Vector3` **angular_velocity** = ``Vector3( 0, 0, 0 )`` + +.. rst-class:: classref-property-setget + +- void **set_angular_velocity** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_angular_velocity** **(** **)** + +The angular velocity of the physics body, in radians per second. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_body_type: + +.. rst-class:: classref-property + +:ref:`String` **body_type** = ``"static"`` + +.. rst-class:: classref-property-setget + +- void **set_body_type** **(** :ref:`String` value **)** +- :ref:`String` **get_body_type** **(** **)** + +The type of the body. Valid values are "static", "kinematic", "character", "rigid", "vehicle", and "trigger". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_linear_velocity: + +.. rst-class:: classref-property + +:ref:`Vector3` **linear_velocity** = ``Vector3( 0, 0, 0 )`` + +.. rst-class:: classref-property-setget + +- void **set_linear_velocity** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_linear_velocity** **(** **)** + +The linear velocity of the physics body, in meters per second. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_mass: + +.. rst-class:: classref-property + +:ref:`float` **mass** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_mass** **(** :ref:`float` value **)** +- :ref:`float` **get_mass** **(** **)** + +The mass of the physics body, in kilograms. This is only used when the body type is "rigid" or "vehicle". + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_GLTFPhysicsBody_method_to_dictionary: + +.. rst-class:: classref-method + +:ref:`Dictionary` **to_dictionary** **(** **)** |const| + +Serializes this GLTFPhysicsBody instance into a :ref:`Dictionary`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_method_to_node: + +.. rst-class:: classref-method + +:ref:`CollisionObject` **to_node** **(** **)** |const| + +Converts this GLTFPhysicsBody instance into a Godot :ref:`CollisionObject` node. + +.. |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.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 7bf94fc80..47b5857a9 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFSkeleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFSkeleton.xml. .. _class_GLTFSkeleton: diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 1fa2af4f4..a8515140e 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFSkin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFSkin.xml. .. _class_GLTFSkin: diff --git a/classes/class_gltfspecgloss.rst b/classes/class_gltfspecgloss.rst index e899f2880..846127ef1 100644 --- a/classes/class_gltfspecgloss.rst +++ b/classes/class_gltfspecgloss.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFSpecGloss.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFSpecGloss.xml. .. _class_GLTFSpecGloss: @@ -19,6 +19,13 @@ Description **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to **GLTFSpecGloss** within a script will cause an error in an exported project. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- `KHR_materials_pbrSpecularGlossiness GLTF extension spec `__ + .. rst-class:: classref-reftable-group Properties @@ -59,9 +66,7 @@ Property Descriptions - void **set_diffuse_factor** **(** :ref:`Color` value **)** - :ref:`Color` **get_diffuse_factor** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The reflected diffuse factor of the material. .. rst-class:: classref-item-separator @@ -78,9 +83,7 @@ Property Descriptions - void **set_diffuse_img** **(** :ref:`Image` value **)** - :ref:`Image` **get_diffuse_img** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The diffuse texture. .. rst-class:: classref-item-separator @@ -97,9 +100,7 @@ Property Descriptions - void **set_gloss_factor** **(** :ref:`float` value **)** - :ref:`float` **get_gloss_factor** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The glossiness or smoothness of the material. .. rst-class:: classref-item-separator @@ -116,9 +117,7 @@ Property Descriptions - void **set_spec_gloss_img** **(** :ref:`Image` value **)** - :ref:`Image` **get_spec_gloss_img** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The specular-glossiness texture. .. rst-class:: classref-item-separator @@ -135,9 +134,7 @@ Property Descriptions - void **set_specular_factor** **(** :ref:`Color` value **)** - :ref:`Color` **get_specular_factor** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The specular RGB color of the material. The alpha channel is unused. .. |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_gltfstate.rst b/classes/class_gltfstate.rst index eed4ba1aa..8e504a555 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFState.xml. .. _class_GLTFState: @@ -12,6 +12,8 @@ GLTFState **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +Represents all data of a GLTF file. + .. rst-class:: classref-introduction-group Description @@ -267,9 +269,7 @@ Property Descriptions - void **set_root_nodes** **(** :ref:`Array` value **)** - :ref:`Array` **get_root_nodes** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The root nodes of the GLTF file. Typically, a GLTF file will only have one scene, and therefore one root node. However, a GLTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Godot scene. .. rst-class:: classref-item-separator @@ -286,9 +286,7 @@ Property Descriptions - void **set_scene_name** **(** :ref:`String` value **)** - :ref:`String` **get_scene_name** **(** **)** -.. container:: contribute - - There is currently no description for this property. Please help us by :ref:`contributing one `! +The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the GLTF file. .. rst-class:: classref-item-separator @@ -392,9 +390,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animations** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +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. .. rst-class:: classref-item-separator @@ -420,9 +416,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_cameras** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFCamera`\ s in the GLTF file. These are the cameras that the :ref:`GLTFNode.camera` index refers to. .. rst-class:: classref-item-separator @@ -448,9 +442,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_lights** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFLight`\ s in the GLTF file. These are the lights that the :ref:`GLTFNode.light` index refers to. .. rst-class:: classref-item-separator @@ -476,9 +468,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_meshes** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFMesh`\ es in the GLTF file. These are the meshes that the :ref:`GLTFNode.mesh` index refers to. .. rst-class:: classref-item-separator @@ -490,9 +480,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_nodes** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +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. .. rst-class:: classref-item-separator @@ -532,9 +520,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_skeletons** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFSkeleton`\ s in the GLTF file. These are the skeletons that the :ref:`GLTFNode.skeleton` index refers to. .. rst-class:: classref-item-separator @@ -546,9 +532,7 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_skins** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of all :ref:`GLTFSkin`\ s in the GLTF file. These are the skins that the :ref:`GLTFNode.skin` index refers to. .. rst-class:: classref-item-separator @@ -586,9 +570,7 @@ Retrieves the array of texture samplers that are used by the textures contained :ref:`Array` **get_unique_animation_names** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of unique animation names. This is only used during the import process. .. rst-class:: classref-item-separator @@ -600,9 +582,7 @@ Retrieves the array of texture samplers that are used by the textures contained :ref:`Array` **get_unique_names** **(** **)** -.. container:: contribute - - There is currently no description for this method. Please help us by :ref:`contributing one `! +Returns an array of unique node names. This is used in both the import process and export process. .. rst-class:: classref-item-separator diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index 0a703246b..192859e8b 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFTexture.xml. .. _class_GLTFTexture: diff --git a/classes/class_gltftexturesampler.rst b/classes/class_gltftexturesampler.rst index f0df2f0d9..0709fd1d0 100644 --- a/classes/class_gltftexturesampler.rst +++ b/classes/class_gltftexturesampler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFTextureSampler.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/GLTFTextureSampler.xml. .. _class_GLTFTextureSampler: diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index f13d8b2c5..9c850a94b 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/mono/doc_classes/GodotSharp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/mono/doc_classes/GodotSharp.xml. .. _class_GodotSharp: diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 5fdbb85e4..d0c215c1b 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Gradient.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Gradient.xml. .. _class_Gradient: diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index d2277cb09..05fbf7968 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GradientTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GradientTexture.xml. .. _class_GradientTexture: diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index 3e5d05082..9204e10d8 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GradientTexture2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GradientTexture2D.xml. .. _class_GradientTexture2D: diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 10e66ef09..4d8010397 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GraphEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GraphEdit.xml. .. _class_GraphEdit: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 4a125ef5a..3cc63d002 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GraphNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GraphNode.xml. .. _class_GraphNode: diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 133c405dc..d81d81466 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GridContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GridContainer.xml. .. _class_GridContainer: diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index c349a4052..a442b0986 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gridmap/doc_classes/GridMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gridmap/doc_classes/GridMap.xml. .. _class_GridMap: diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index fae9ee2b4..661423d61 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/GrooveJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GrooveJoint2D.xml. .. _class_GrooveJoint2D: diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index 483254241..30f3d8ca9 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HashingContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HashingContext.xml. .. _class_HashingContext: diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index c67637fcb..9fe708a0c 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HBoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HBoxContainer.xml. .. _class_HBoxContainer: diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst index ac435a051..9af043bcc 100644 --- a/classes/class_heightmapshape.rst +++ b/classes/class_heightmapshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HeightMapShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HeightMapShape.xml. .. _class_HeightMapShape: diff --git a/classes/class_hflowcontainer.rst b/classes/class_hflowcontainer.rst index f33a08472..9e74cde94 100644 --- a/classes/class_hflowcontainer.rst +++ b/classes/class_hflowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HFlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HFlowContainer.xml. .. _class_HFlowContainer: diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 545c68806..663963da2 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HingeJoint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HingeJoint.xml. .. _class_HingeJoint: diff --git a/classes/class_hmaccontext.rst b/classes/class_hmaccontext.rst index cb10f5f17..00509f35c 100644 --- a/classes/class_hmaccontext.rst +++ b/classes/class_hmaccontext.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HMACContext.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HMACContext.xml. .. _class_HMACContext: diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index bc847d203..c4701f064 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HScrollBar.xml. .. _class_HScrollBar: diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 71fdca83f..5fed6fcc3 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HSeparator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HSeparator.xml. .. _class_HSeparator: diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index bc882e942..adb5bfaef 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HSlider.xml. .. _class_HSlider: diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index a895476e7..9c5d1c385 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HSplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HSplitContainer.xml. .. _class_HSplitContainer: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index d53b4c001..e65872bf8 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HTTPClient.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HTTPClient.xml. .. _class_HTTPClient: diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 673359e6d..ec7e3684c 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/HTTPRequest.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/HTTPRequest.xml. .. _class_HTTPRequest: diff --git a/classes/class_image.rst b/classes/class_image.rst index 7a591e4ca..a5a49eb6a 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Image.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Image.xml. .. _class_Image: @@ -1385,6 +1385,15 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo img.unlock() img.set_pixel(x, y, color) # Does not have an effect +\ **Note:** Some image methods can leave the image unlocked, making subsequent :ref:`set_pixel` calls fail unless the image is locked again. Methods potentially unlocking the image: :ref:`blend_rect`, :ref:`blend_rect_mask`, :ref:`blit_rect_mask`, :ref:`convert`, :ref:`fill`, :ref:`fill_rect`, :ref:`get_used_rect`, and :ref:`rgbe_to_srgb`. + +:: + + img.lock() + img.set_pixel(x, y, color) # Works + img.fill(color) # Unlocks the image + img.set_pixel(x, y, color) # Does not have an effect + .. rst-class:: classref-item-separator ---- @@ -1406,6 +1415,15 @@ Sets the :ref:`Color` of the pixel at ``(dst.x, dst.y)`` if the ima img.unlock() img.set_pixelv(Vector2(x, y), color) # Does not have an effect +\ **Note:** Some image methods can leave the image unlocked, making subsequent :ref:`set_pixelv` calls fail unless the image is locked again. Methods potentially unlocking the image: :ref:`blend_rect`, :ref:`blend_rect_mask`, :ref:`blit_rect_mask`, :ref:`convert`, :ref:`fill`, :ref:`fill_rect`, :ref:`get_used_rect`, and :ref:`rgbe_to_srgb`. + +:: + + img.lock() + img.set_pixelv(Vector2(x, y), color) # Works + img.fill(dcolor) # Unlocks the image + img.set_pixelv(Vector2(x, y), color) # Does not have an effect + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index f5ba3869c..c443d1165 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ImageTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ImageTexture.xml. .. _class_ImageTexture: @@ -51,6 +51,8 @@ An **ImageTexture** is not meant to be operated from within the editor interface \ **Note:** The maximum texture size is 16384×16384 pixels due to graphics hardware limitations. +\ **Note:** Mipmap generation can fail with some graphics drivers (especially on Android), resulting in black textures. In these cases, consider either calling :ref:`Image.generate_mipmaps`, or creating an **ImageTexture** without :ref:`Texture.FLAG_MIPMAPS`. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index e7dc9b69c..7c9fe7882 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ImmediateGeometry.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ImmediateGeometry.xml. .. _class_ImmediateGeometry: diff --git a/classes/class_input.rst b/classes/class_input.rst index 69c413ce3..04bc36567 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Input.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Input.xml. .. _class_Input: @@ -139,6 +139,8 @@ Methods +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_magnetometer` **(** :ref:`Vector3` value **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`should_ignore_device` **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| | + +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | @@ -650,7 +652,7 @@ Receives a gamepad button from :ref:`JoystickList` **get_joy_guid** **(** :ref:`int` device **)** |const| -Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns ``"Default Gamepad"`` otherwise. +Returns a SDL2-compatible device GUID on platforms that use gamepad remapping, e.g. ``030000004c050000c405000000010000``. Returns ``"Default Gamepad"`` otherwise. Godot uses the `SDL2 game controller database `__ to determine gamepad names and mappings based on this GUID. .. rst-class:: classref-item-separator @@ -662,7 +664,7 @@ Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. R :ref:`String` **get_joy_name** **(** :ref:`int` device **)** -Returns the name of the joypad at the specified device index. +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. .. rst-class:: classref-item-separator @@ -752,12 +754,14 @@ By default, the deadzone is automatically calculated from the average of the act :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action, :ref:`bool` exact=false **)** |const| -Returns ``true`` when the user starts pressing the action event, meaning it's ``true`` only on the frame that the user pressed down the button. +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. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. If ``exact`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. +\ **Note:** Returning ``true`` does not imply that the action is *still* pressed. An action can be pressed and released again rapidly, and ``true`` will still be returned so as not to miss input. + \ **Note:** Due to keyboard ghosting, :ref:`is_action_just_pressed` may return ``false`` even if one of the action's keys is pressed. See `Input examples <../tutorials/inputs/input_examples.html#keyboard-events>`__ in the documentation for more information. .. rst-class:: classref-item-separator @@ -770,10 +774,12 @@ If ``exact`` is ``false``, it ignores additional input modifiers for :ref:`Input :ref:`bool` **is_action_just_released** **(** :ref:`String` action, :ref:`bool` exact=false **)** |const| -Returns ``true`` when the user stops pressing the action event, meaning it's ``true`` only on the frame that the user released the button. +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. If ``exact`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. +\ **Note:** Returning ``true`` does not imply that the action is *still* not pressed. An action can be released and pressed again rapidly, and ``true`` will still be returned so as not to miss input. + .. rst-class:: classref-item-separator ---- @@ -931,7 +937,7 @@ void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :r 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. -\ ``image``'s size must be lower than 256×256. +\ ``image``'s size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended. \ ``hotspot`` must be within ``image``'s size. @@ -1003,6 +1009,20 @@ Sets the value of the magnetic field of the magnetometer sensor. Can be used for ---- +.. _class_Input_method_should_ignore_device: + +.. rst-class:: classref-method + +:ref:`bool` **should_ignore_device** **(** :ref:`int` vendor_id, :ref:`int` product_id **)** |const| + +Queries whether an input device should be ignored or not. Devices can be ignored by setting the environment variable ``SDL_GAMECONTROLLER_IGNORE_DEVICES``. Read the `SDL documentation `__ for more information. + +\ **Note:** Some 3rd party tools can contribute to the list of ignored devices. For example, *SteamInput* creates virtual devices from physical devices for remapping purposes. To avoid handling the same input device twice, the original device is added to the ignore list. + +.. rst-class:: classref-item-separator + +---- + .. _class_Input_method_start_joy_vibration: .. rst-class:: classref-method diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 0577bd634..3cdf62763 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEvent.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEvent.xml. .. _class_InputEvent: @@ -71,10 +71,14 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_type` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_canceled` **(** **)** |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_echo` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_released` **(** **)** |const| | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event, :ref:`bool` exact_match=true **)** |const| | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** |const| | @@ -209,6 +213,18 @@ Returns ``true`` if this input event's type is one that can be assigned to an in ---- +.. _class_InputEvent_method_is_canceled: + +.. rst-class:: classref-method + +:ref:`bool` **is_canceled** **(** **)** |const| + +Returns ``true`` if this input event has been canceled. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputEvent_method_is_echo: .. rst-class:: classref-method @@ -235,6 +251,18 @@ Returns ``true`` if this input event is pressed. Not relevant for events of type ---- +.. _class_InputEvent_method_is_released: + +.. rst-class:: classref-method + +:ref:`bool` **is_released** **(** **)** |const| + +Returns ``true`` if this input event is released. Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputEvent_method_shortcut_match: .. rst-class:: classref-method diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index f185e012b..261fa4bed 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventAction.xml. .. _class_InputEventAction: diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 24e59af03..c96185eca 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventGesture.xml. .. _class_InputEventGesture: diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index f8bac6d1b..9e65d9e58 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventJoypadButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventJoypadButton.xml. .. _class_InputEventJoypadButton: @@ -100,6 +100,8 @@ If ``true``, the button's state is pressed. If ``false``, the button's state is Represents the pressure the user puts on the button with their finger, if the controller supports it. Ranges from ``0`` to ``1``. +\ **Note:** This property is never set by the engine and is always ``0``. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 7b0c14f41..54014bd23 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventJoypadMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventJoypadMotion.xml. .. _class_InputEventJoypadMotion: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index c23c97b93..e6b0ffeca 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventKey.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventKey.xml. .. _class_InputEventKey: diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 4f847ea22..e72f30b93 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventMagnifyGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMagnifyGesture.xml. .. _class_InputEventMagnifyGesture: @@ -12,9 +12,12 @@ InputEventMagnifyGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -.. container:: contribute +.. rst-class:: classref-introduction-group - There is currently no description for this class. Please help us by :ref:`contributing one `! +Description +----------- + +**Note:** On Android, this requires the :ref:`ProjectSettings.input_devices/pointing/android/enable_pan_and_scale_gestures` project setting to be enabled. .. rst-class:: classref-reftable-group diff --git a/classes/class_inputeventmidi.rst b/classes/class_inputeventmidi.rst index 23f4e1ef4..704a00c63 100644 --- a/classes/class_inputeventmidi.rst +++ b/classes/class_inputeventmidi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventMIDI.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMIDI.xml. .. _class_InputEventMIDI: diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index d245bc601..7089b67f6 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventMouse.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMouse.xml. .. _class_InputEventMouse: diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 8d8e6bd4e..4a6f90db2 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventMouseButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMouseButton.xml. .. _class_InputEventMouseButton: @@ -21,6 +21,8 @@ Description Contains mouse click information. See :ref:`Node._input`. +\ **Note:** On Wear OS devices, rotary input is mapped to :ref:`@GlobalScope.BUTTON_WHEEL_UP` and :ref:`@GlobalScope.BUTTON_WHEEL_DOWN`. This can be changed to :ref:`@GlobalScope.BUTTON_WHEEL_LEFT` and :ref:`@GlobalScope.BUTTON_WHEEL_RIGHT` with the :ref:`ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis` setting. + .. rst-class:: classref-introduction-group Tutorials @@ -39,6 +41,8 @@ Properties +---------------------------+------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`button_index` | ``0`` | +---------------------------+------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`canceled` | ``false`` | + +---------------------------+------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`doubleclick` | ``false`` | +---------------------------+------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`factor` | ``1.0`` | @@ -72,6 +76,23 @@ The mouse button identifier, one of the :ref:`ButtonList` **canceled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_canceled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_canceled** **(** **)** + +If ``true``, the mouse button event has been canceled. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputEventMouseButton_property_doubleclick: .. rst-class:: classref-property diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 75782a31e..443c344d8 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventMouseMotion.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMouseMotion.xml. .. _class_InputEventMouseMotion: diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 828c1f683..707fd6291 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventPanGesture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventPanGesture.xml. .. _class_InputEventPanGesture: @@ -12,9 +12,12 @@ InputEventPanGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -.. container:: contribute +.. rst-class:: classref-introduction-group - There is currently no description for this class. Please help us by :ref:`contributing one `! +Description +----------- + +**Note:** On Android, this requires the :ref:`ProjectSettings.input_devices/pointing/android/enable_pan_and_scale_gestures` project setting to be enabled. .. rst-class:: classref-reftable-group diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 61e959744..978573ca5 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventScreenDrag.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventScreenDrag.xml. .. _class_InputEventScreenDrag: diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 70ff8d2d2..6ca349140 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventScreenTouch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventScreenTouch.xml. .. _class_InputEventScreenTouch: @@ -38,6 +38,8 @@ Properties .. table:: :widths: auto + +-------------------------------+--------------------------------------------------------------------+---------------------+ + | :ref:`bool` | :ref:`canceled` | ``false`` | +-------------------------------+--------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`double_tap` | ``false`` | +-------------------------------+--------------------------------------------------------------------+---------------------+ @@ -57,6 +59,23 @@ Properties Property Descriptions --------------------- +.. _class_InputEventScreenTouch_property_canceled: + +.. rst-class:: classref-property + +:ref:`bool` **canceled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_canceled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_canceled** **(** **)** + +If ``true``, the touch event has been canceled. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputEventScreenTouch_property_double_tap: .. rst-class:: classref-property diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index e6378eea1..81efb59ef 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventWithModifiers.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventWithModifiers.xml. .. _class_InputEventWithModifiers: diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index cf25a6c61..e130363a5 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputMap.xml. .. _class_InputMap: diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 09de06265..afd1092d6 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InstancePlaceholder.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InstancePlaceholder.xml. .. _class_InstancePlaceholder: diff --git a/classes/class_int.rst b/classes/class_int.rst index aa90ae350..768800100 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/int.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/int.xml. .. _class_int: diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index 0f44027a9..7b642db48 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InterpolatedCamera.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InterpolatedCamera.xml. .. _class_InterpolatedCamera: diff --git a/classes/class_intervaltweener.rst b/classes/class_intervaltweener.rst index f451fe6d2..90a1d7c30 100644 --- a/classes/class_intervaltweener.rst +++ b/classes/class_intervaltweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/IntervalTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/IntervalTweener.xml. .. _class_IntervalTweener: diff --git a/classes/class_ip.rst b/classes/class_ip.rst index b2daa74b3..9a5a22456 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/IP.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/IP.xml. .. _class_IP: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 0a744f793..b061b4b23 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ItemList.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ItemList.xml. .. _class_ItemList: @@ -40,6 +40,8 @@ Properties +---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | +---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`auto_height` | ``false`` | +---------------------------------------------+-----------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`fixed_column_width` | ``0`` | @@ -376,6 +378,23 @@ If ``true``, right mouse button click can select items. ---- +.. _class_ItemList_property_allow_search: + +.. rst-class:: classref-property + +:ref:`bool` **allow_search** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_allow_search** **(** :ref:`bool` value **)** +- :ref:`bool` **get_allow_search** **(** **)** + +If ``true``, allows navigating the **ItemList** with letter keys through incremental search. + +.. rst-class:: classref-item-separator + +---- + .. _class_ItemList_property_auto_height: .. rst-class:: classref-property diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index 6d43234a5..294f53fc6 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JavaClass.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JavaClass.xml. .. _class_JavaClass: diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index f246afbab..29472950e 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JavaClassWrapper.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JavaClassWrapper.xml. .. _class_JavaClassWrapper: diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 6d3765df3..b8918b2d3 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JavaScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JavaScript.xml. .. _class_JavaScript: diff --git a/classes/class_javascriptobject.rst b/classes/class_javascriptobject.rst index a1a01c299..914075f4a 100644 --- a/classes/class_javascriptobject.rst +++ b/classes/class_javascriptobject.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JavaScriptObject.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JavaScriptObject.xml. .. _class_JavaScriptObject: diff --git a/classes/class_jnisingleton.rst b/classes/class_jnisingleton.rst index 7ad20edbe..a3a3b3c43 100644 --- a/classes/class_jnisingleton.rst +++ b/classes/class_jnisingleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JNISingleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JNISingleton.xml. .. _class_JNISingleton: diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 7716662b2..7ac8f6c8c 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Joint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Joint.xml. .. _class_Joint: diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 0b8b55ae2..7079cd952 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Joint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Joint2D.xml. .. _class_Joint2D: diff --git a/classes/class_json.rst b/classes/class_json.rst index 9edb7e2d8..9d9b901e6 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JSON.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JSON.xml. .. _class_JSON: diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 564539694..4867780d6 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JSONParseResult.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JSONParseResult.xml. .. _class_JSONParseResult: diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index ecdfb4c6d..09a08e655 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/JSONRPC.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/JSONRPC.xml. .. _class_JSONRPC: diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index befde4d54..161e1a0b0 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/KinematicBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/KinematicBody.xml. .. _class_KinematicBody: @@ -25,6 +25,8 @@ Kinematic bodies are special types of bodies that are meant to be user-controlle \ **Kinematic characters:** KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but don't require advanced physics. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 4734f1b7c..5d469053e 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/KinematicBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/KinematicBody2D.xml. .. _class_KinematicBody2D: diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 2b5e73983..2ce7e74ea 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/KinematicCollision.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/KinematicCollision.xml. .. _class_KinematicCollision: diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 1f6a47783..cf0dd7041 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/KinematicCollision2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/KinematicCollision2D.xml. .. _class_KinematicCollision2D: diff --git a/classes/class_label.rst b/classes/class_label.rst index e01f2ef72..13558aca7 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Label.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Label.xml. .. _class_Label: diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index de2d8ca7c..ce9c99e3d 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Label3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Label3D.xml. .. _class_Label3D: @@ -29,49 +29,49 @@ Properties .. table:: :widths: auto - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`AlphaCutMode` | :ref:`alpha_cut` | ``0`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`alpha_scissor_threshold` | ``0.5`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`autowrap` | ``false`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`double_sided` | ``true`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`fixed_size` | ``false`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`Font` | :ref:`font` | | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`Align` | :ref:`horizontal_alignment` | ``1`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`line_spacing` | ``0.0`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`no_depth_test` | ``false`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`outline_modulate` | ``Color( 0, 0, 0, 1 )`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`outline_render_priority` | ``-1`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`pixel_size` | ``0.01`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`render_priority` | ``0`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`shaded` | ``false`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`String` | :ref:`text` | ``""`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`uppercase` | ``false`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`VAlign` | :ref:`vertical_alignment` | ``1`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`width` | ``500.0`` | - +----------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`AlphaCutMode` | :ref:`alpha_cut` | ``0`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`alpha_scissor_threshold` | ``0.5`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`autowrap` | ``false`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`double_sided` | ``true`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`fixed_size` | ``false`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`Font` | :ref:`font` | | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`Align` | :ref:`horizontal_alignment` | ``1`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`line_spacing` | ``0.0`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`no_depth_test` | ``false`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`outline_modulate` | ``Color( 0, 0, 0, 1 )`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`outline_render_priority` | ``-1`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`pixel_size` | ``0.01`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`render_priority` | ``0`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`shaded` | ``false`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`String` | :ref:`text` | ``""`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`uppercase` | ``false`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`VAlign` | :ref:`vertical_alignment` | ``1`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`width` | ``500.0`` | + +-----------------------------------------------------+--------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group @@ -332,14 +332,14 @@ If ``true``, wraps the text to the :ref:`width`. .. rst-class:: classref-property -:ref:`BillboardMode` **billboard** = ``0`` +:ref:`BillboardMode` **billboard** = ``0`` .. rst-class:: classref-property-setget -- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** +- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** +- :ref:`BillboardMode` **get_billboard_mode** **(** **)** -The billboard mode to use for the label. See :ref:`BillboardMode` for possible values. +The billboard mode to use for the label. See :ref:`BillboardMode` for possible values. .. rst-class:: classref-item-separator diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 036eee9a9..2a40b9270 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LargeTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LargeTexture.xml. .. _class_LargeTexture: diff --git a/classes/class_light.rst b/classes/class_light.rst index 5d288ac50..edd4c6e3f 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Light.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Light.xml. .. _class_Light: @@ -227,11 +227,19 @@ Constant for accessing :ref:`shadow_bias`. Constant for accessing :ref:`DirectionalLight.directional_shadow_bias_split_scale`. +.. _class_Light_constant_PARAM_SHADOW_FADE_START: + +.. rst-class:: classref-enumeration-constant + +:ref:`Param` **PARAM_SHADOW_FADE_START** = ``16`` + +Constant for accessing :ref:`DirectionalLight.directional_shadow_fade_start`. + .. _class_Light_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Param` **PARAM_MAX** = ``16`` +:ref:`Param` **PARAM_MAX** = ``17`` Represents the size of the :ref:`Param` enum. diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index ede52925d..5fe653656 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Light2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Light2D.xml. .. _class_Light2D: diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 1c2246d55..754e8365d 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LightOccluder2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LightOccluder2D.xml. .. _class_LightOccluder2D: diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 09504902f..ed5ec43c4 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Line2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Line2D.xml. .. _class_Line2D: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 028ac6c03..03b81d303 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LineEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LineEdit.xml. .. _class_LineEdit: diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index b7a9fbea3..456ceefac 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LineShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LineShape2D.xml. .. _class_LineShape2D: diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 151265159..17309aba8 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LinkButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LinkButton.xml. .. _class_LinkButton: diff --git a/classes/class_listener.rst b/classes/class_listener.rst index a1f813b51..b41298957 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Listener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Listener.xml. .. _class_Listener: diff --git a/classes/class_listener2d.rst b/classes/class_listener2d.rst index d310ff249..b4122c029 100644 --- a/classes/class_listener2d.rst +++ b/classes/class_listener2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Listener2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Listener2D.xml. .. _class_Listener2D: diff --git a/classes/class_lod.rst b/classes/class_lod.rst new file mode 100644 index 000000000..b082c4e09 --- /dev/null +++ b/classes/class_lod.rst @@ -0,0 +1,88 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/LOD.xml. + +.. _class_LOD: + +LOD +=== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +Provides discrete level of detail. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Automatically hides and shows :ref:`Spatial` children depending on the distance from the closest :ref:`Camera` to the **LOD** node. Child nodes that don't inherit from :ref:`Spatial` are ignored by the LOD system. + +Children are shown in order with the first children shown when closest to the :ref:`Camera`, and the latter children shown when further away. + +The threshold distances for changes are determined by :ref:`Spatial.lod_range`. + +For example, a first child with a range of ``2`` will be shown from distance 0 to 2. A second child with a range of ``5`` will be shown from distance 2 to 7, etc. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------+------------------------------------------------------+---------+ + | :ref:`float` | :ref:`hysteresis` | ``1.0`` | + +---------------------------+------------------------------------------------------+---------+ + | :ref:`int` | :ref:`lod_priority` | ``0`` | + +---------------------------+------------------------------------------------------+---------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_LOD_property_hysteresis: + +.. rst-class:: classref-property + +:ref:`float` **hysteresis** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_hysteresis** **(** :ref:`float` value **)** +- :ref:`float` **get_hysteresis** **(** **)** + +To prevent flickering at borders, a hysteresis distance will be added to threshold distances when the object is moving away from the :ref:`Camera`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LOD_property_lod_priority: + +.. rst-class:: classref-property + +:ref:`int` **lod_priority** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_lod_priority** **(** :ref:`int` value **)** +- :ref:`int` **get_lod_priority** **(** **)** + +Determines the rate at which level of detail will be updated. + +Higher priorities will update faster, but use more CPU. + +.. |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.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index bc8af2117..dc7b60614 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MainLoop.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MainLoop.xml. .. _class_MainLoop: @@ -250,7 +250,7 @@ Specific to the macOS platform. Notification received from the OS when the app is resumed. -Specific to the Android platform. +Specific to mobile platforms. .. _class_MainLoop_constant_NOTIFICATION_APP_PAUSED: @@ -260,7 +260,9 @@ Specific to the Android platform. Notification received from the OS when the app is paused. -Specific to the Android platform. +Specific to mobile platforms. + +\ **Note:** On iOS, you only have approximately 5 seconds to finish a task started by this signal. If you go over this allotment, iOS will kill the app instead of pausing it. .. rst-class:: classref-section-separator diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index b1c6a8bef..017e7fe02 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MarginContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MarginContainer.xml. .. _class_MarginContainer: diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index c12629737..c7ae4bc55 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Marshalls.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Marshalls.xml. .. _class_Marshalls: diff --git a/classes/class_material.rst b/classes/class_material.rst index 2977fb1cb..300e00d9e 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Material.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Material.xml. .. _class_Material: @@ -12,7 +12,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CanvasItemMaterial`, :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial` +**Inherited By:** :ref:`CanvasItemMaterial`, :ref:`Material3D`, :ref:`ParticlesMaterial`, :ref:`ShaderMaterial` Abstract base :ref:`Resource` for coloring and shading geometry. diff --git a/classes/class_material3d.rst b/classes/class_material3d.rst new file mode 100644 index 000000000..04a72d4d7 --- /dev/null +++ b/classes/class_material3d.rst @@ -0,0 +1,3033 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Material3D.xml. + +.. _class_Material3D: + +Material3D +========== + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ORMSpatialMaterial`, :ref:`SpatialMaterial` + +.. container:: contribute + + There is currently no description for this class. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`albedo_color` | ``Color( 1, 1, 1, 1 )`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`albedo_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`anisotropy` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`anisotropy_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`anisotropy_flowmap` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`ao_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`ao_light_affect` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`ao_on_uv2` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`ao_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`TextureChannel` | :ref:`ao_texture_channel` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`AsyncMode` | :ref:`async_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`clearcoat` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`clearcoat_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`clearcoat_gloss` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`clearcoat_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`depth_deep_parallax` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`depth_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`depth_flip_binormal` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`depth_flip_tangent` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`depth_max_layers` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`depth_min_layers` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`depth_scale` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`depth_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`detail_albedo` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`BlendMode` | :ref:`detail_blend_mode` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`detail_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`detail_mask` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`detail_normal` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`DetailUV` | :ref:`detail_uv_layer` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`distance_fade_max_distance` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`distance_fade_min_distance` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`emission` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`emission_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`emission_energy` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`emission_on_uv2` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`EmissionOperator` | :ref:`emission_operator` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`emission_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_albedo_tex_msdf` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_disable_ambient_light` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_do_not_receive_shadows` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_ensure_correct_normals` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_fixed_size` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_no_depth_test` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_transparent` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_unshaded` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_use_point_size` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_use_shadow_to_opacity` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_vertex_lighting` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flags_world_triplanar` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`metallic` | ``0.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`metallic_specular` | ``0.5`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`metallic_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`TextureChannel` | :ref:`metallic_texture_channel` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`normal_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`normal_scale` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`normal_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`orm_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`params_alpha_scissor_threshold` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`params_billboard_keep_scale` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`BillboardMode` | :ref:`params_billboard_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`BlendMode` | :ref:`params_blend_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`CullMode` | :ref:`params_cull_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`params_grow` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`params_grow_amount` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`params_line_width` | ``1.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`params_point_size` | ``1.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`SpecularMode` | :ref:`params_specular_mode` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`params_use_alpha_scissor` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`particles_anim_h_frames` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`particles_anim_loop` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`particles_anim_v_frames` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`proximity_fade_distance` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`proximity_fade_enable` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`refraction_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`refraction_scale` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`refraction_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`TextureChannel` | :ref:`refraction_texture_channel` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`rim` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`rim_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`rim_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`rim_tint` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`roughness` | ``1.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`roughness_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`TextureChannel` | :ref:`roughness_texture_channel` | ``0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`subsurf_scatter_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`subsurf_scatter_strength` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`subsurf_scatter_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`transmission` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`transmission_enabled` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture` | :ref:`transmission_texture` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`uv1_offset` | ``Vector3( 0, 0, 0 )`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`uv1_scale` | ``Vector3( 1, 1, 1 )`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`uv1_triplanar` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`uv1_triplanar_sharpness` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`uv2_offset` | ``Vector3( 0, 0, 0 )`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`uv2_scale` | ``Vector3( 1, 1, 1 )`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`uv2_triplanar` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`uv2_triplanar_sharpness` | | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`vertex_color_is_srgb` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ``false`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** |const| | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_feature` **(** :ref:`Feature` feature, :ref:`bool` enable **)** | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_texture` **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** | + +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_Material3D_TextureParam: + +.. rst-class:: classref-enumeration + +enum **TextureParam**: + +.. _class_Material3D_constant_TEXTURE_ALBEDO: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_ALBEDO** = ``0`` + +Texture specifying per-pixel color. + +.. _class_Material3D_constant_TEXTURE_METALLIC: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_METALLIC** = ``1`` + +Texture specifying per-pixel metallic value. + +.. _class_Material3D_constant_TEXTURE_ROUGHNESS: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_ROUGHNESS** = ``2`` + +Texture specifying per-pixel roughness value. + +.. _class_Material3D_constant_TEXTURE_EMISSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_EMISSION** = ``3`` + +Texture specifying per-pixel emission color. + +.. _class_Material3D_constant_TEXTURE_NORMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_NORMAL** = ``4`` + +Texture specifying per-pixel normal vector. + +.. _class_Material3D_constant_TEXTURE_RIM: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_RIM** = ``5`` + +Texture specifying per-pixel rim value. + +.. _class_Material3D_constant_TEXTURE_CLEARCOAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_CLEARCOAT** = ``6`` + +Texture specifying per-pixel clearcoat value. + +.. _class_Material3D_constant_TEXTURE_FLOWMAP: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_FLOWMAP** = ``7`` + +Texture specifying per-pixel flowmap direction for use with :ref:`anisotropy`. + +.. _class_Material3D_constant_TEXTURE_AMBIENT_OCCLUSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_AMBIENT_OCCLUSION** = ``8`` + +Texture specifying per-pixel ambient occlusion value. + +.. _class_Material3D_constant_TEXTURE_DEPTH: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_DEPTH** = ``9`` + +Texture specifying per-pixel depth. + +.. _class_Material3D_constant_TEXTURE_SUBSURFACE_SCATTERING: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_SUBSURFACE_SCATTERING** = ``10`` + +Texture specifying per-pixel subsurface scattering. + +.. _class_Material3D_constant_TEXTURE_TRANSMISSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_TRANSMISSION** = ``11`` + +Texture specifying per-pixel transmission color. + +.. _class_Material3D_constant_TEXTURE_REFRACTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_REFRACTION** = ``12`` + +Texture specifying per-pixel refraction strength. + +.. _class_Material3D_constant_TEXTURE_DETAIL_MASK: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_DETAIL_MASK** = ``13`` + +Texture specifying per-pixel detail mask blending value. + +.. _class_Material3D_constant_TEXTURE_DETAIL_ALBEDO: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_DETAIL_ALBEDO** = ``14`` + +Texture specifying per-pixel detail color. + +.. _class_Material3D_constant_TEXTURE_DETAIL_NORMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_DETAIL_NORMAL** = ``15`` + +Texture specifying per-pixel detail normal. + +.. _class_Material3D_constant_TEXTURE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureParam` **TEXTURE_MAX** = ``17`` + +Represents the size of the :ref:`TextureParam` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_DetailUV: + +.. rst-class:: classref-enumeration + +enum **DetailUV**: + +.. _class_Material3D_constant_DETAIL_UV_1: + +.. rst-class:: classref-enumeration-constant + +:ref:`DetailUV` **DETAIL_UV_1** = ``0`` + +Use ``UV`` with the detail texture. + +.. _class_Material3D_constant_DETAIL_UV_2: + +.. rst-class:: classref-enumeration-constant + +:ref:`DetailUV` **DETAIL_UV_2** = ``1`` + +Use ``UV2`` with the detail texture. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_Feature: + +.. rst-class:: classref-enumeration + +enum **Feature**: + +.. _class_Material3D_constant_FEATURE_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_TRANSPARENT** = ``0`` + +Constant for setting :ref:`flags_transparent`. + +.. _class_Material3D_constant_FEATURE_EMISSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_EMISSION** = ``1`` + +Constant for setting :ref:`emission_enabled`. + +.. _class_Material3D_constant_FEATURE_NORMAL_MAPPING: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_NORMAL_MAPPING** = ``2`` + +Constant for setting :ref:`normal_enabled`. + +.. _class_Material3D_constant_FEATURE_RIM: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_RIM** = ``3`` + +Constant for setting :ref:`rim_enabled`. + +.. _class_Material3D_constant_FEATURE_CLEARCOAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_CLEARCOAT** = ``4`` + +Constant for setting :ref:`clearcoat_enabled`. + +.. _class_Material3D_constant_FEATURE_ANISOTROPY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_ANISOTROPY** = ``5`` + +Constant for setting :ref:`anisotropy_enabled`. + +.. _class_Material3D_constant_FEATURE_AMBIENT_OCCLUSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_AMBIENT_OCCLUSION** = ``6`` + +Constant for setting :ref:`ao_enabled`. + +.. _class_Material3D_constant_FEATURE_DEPTH_MAPPING: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_DEPTH_MAPPING** = ``7`` + +Constant for setting :ref:`depth_enabled`. + +.. _class_Material3D_constant_FEATURE_SUBSURACE_SCATTERING: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_SUBSURACE_SCATTERING** = ``8`` + +Constant for setting :ref:`subsurf_scatter_enabled`. + +.. _class_Material3D_constant_FEATURE_TRANSMISSION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_TRANSMISSION** = ``9`` + +Constant for setting :ref:`transmission_enabled`. + +.. _class_Material3D_constant_FEATURE_REFRACTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_REFRACTION** = ``10`` + +Constant for setting :ref:`refraction_enabled`. + +.. _class_Material3D_constant_FEATURE_DETAIL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_DETAIL** = ``11`` + +Constant for setting :ref:`detail_enabled`. + +.. _class_Material3D_constant_FEATURE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`Feature` **FEATURE_MAX** = ``12`` + +Represents the size of the :ref:`Feature` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_BlendMode: + +.. rst-class:: classref-enumeration + +enum **BlendMode**: + +.. _class_Material3D_constant_BLEND_MODE_MIX: + +.. rst-class:: classref-enumeration-constant + +:ref:`BlendMode` **BLEND_MODE_MIX** = ``0`` + +Default blend mode. The color of the object is blended over the background based on the object's alpha value. + +.. _class_Material3D_constant_BLEND_MODE_ADD: + +.. rst-class:: classref-enumeration-constant + +:ref:`BlendMode` **BLEND_MODE_ADD** = ``1`` + +The color of the object is added to the background. + +.. _class_Material3D_constant_BLEND_MODE_SUB: + +.. rst-class:: classref-enumeration-constant + +:ref:`BlendMode` **BLEND_MODE_SUB** = ``2`` + +The color of the object is subtracted from the background. + +.. _class_Material3D_constant_BLEND_MODE_MUL: + +.. rst-class:: classref-enumeration-constant + +:ref:`BlendMode` **BLEND_MODE_MUL** = ``3`` + +The color of the object is multiplied by the background. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_DepthDrawMode: + +.. rst-class:: classref-enumeration + +enum **DepthDrawMode**: + +.. _class_Material3D_constant_DEPTH_DRAW_OPAQUE_ONLY: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthDrawMode` **DEPTH_DRAW_OPAQUE_ONLY** = ``0`` + +Default depth draw mode. Depth is drawn only for opaque objects. + +.. _class_Material3D_constant_DEPTH_DRAW_ALWAYS: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthDrawMode` **DEPTH_DRAW_ALWAYS** = ``1`` + +Depth draw is calculated for both opaque and transparent objects. + +.. _class_Material3D_constant_DEPTH_DRAW_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthDrawMode` **DEPTH_DRAW_DISABLED** = ``2`` + +No depth draw. + +.. _class_Material3D_constant_DEPTH_DRAW_ALPHA_OPAQUE_PREPASS: + +.. rst-class:: classref-enumeration-constant + +:ref:`DepthDrawMode` **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = ``3`` + +For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_CullMode: + +.. rst-class:: classref-enumeration + +enum **CullMode**: + +.. _class_Material3D_constant_CULL_BACK: + +.. rst-class:: classref-enumeration-constant + +:ref:`CullMode` **CULL_BACK** = ``0`` + +Default cull mode. The back of the object is culled when not visible. + +.. _class_Material3D_constant_CULL_FRONT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CullMode` **CULL_FRONT** = ``1`` + +The front of the object is culled when not visible. + +.. _class_Material3D_constant_CULL_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`CullMode` **CULL_DISABLED** = ``2`` + +No culling is performed. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_Flags: + +.. rst-class:: classref-enumeration + +enum **Flags**: + +.. _class_Material3D_constant_FLAG_UNSHADED: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_UNSHADED** = ``0`` + +No lighting is used on the object. Color comes directly from ``ALBEDO``. + +.. _class_Material3D_constant_FLAG_USE_VERTEX_LIGHTING: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_VERTEX_LIGHTING** = ``1`` + +Lighting is calculated per-vertex rather than per-pixel. This can be used to increase the speed of the shader at the cost of quality. + +.. _class_Material3D_constant_FLAG_DISABLE_DEPTH_TEST: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_DISABLE_DEPTH_TEST** = ``2`` + +Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it. + +.. _class_Material3D_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_ALBEDO_FROM_VERTEX_COLOR** = ``3`` + +Set ``ALBEDO`` to the per-vertex color specified in the mesh. + +.. _class_Material3D_constant_FLAG_SRGB_VERTEX_COLOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_SRGB_VERTEX_COLOR** = ``4`` + +Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer. + +.. _class_Material3D_constant_FLAG_USE_POINT_SIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_POINT_SIZE** = ``5`` + +Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use ``POINT_COORD`` instead of ``UV``. + +.. _class_Material3D_constant_FLAG_FIXED_SIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_FIXED_SIZE** = ``6`` + +Object is scaled by depth so that it always appears the same size on screen. + +.. _class_Material3D_constant_FLAG_BILLBOARD_KEEP_SCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_BILLBOARD_KEEP_SCALE** = ``7`` + +Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`params_billboard_mode` is :ref:`BILLBOARD_ENABLED`. + +.. _class_Material3D_constant_FLAG_UV1_USE_TRIPLANAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_UV1_USE_TRIPLANAR** = ``8`` + +Use triplanar texture lookup for all texture lookups that would normally use ``UV``. + +.. _class_Material3D_constant_FLAG_UV2_USE_TRIPLANAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_UV2_USE_TRIPLANAR** = ``9`` + +Use triplanar texture lookup for all texture lookups that would normally use ``UV2``. + +.. _class_Material3D_constant_FLAG_AO_ON_UV2: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_AO_ON_UV2** = ``11`` + +Use ``UV2`` coordinates to look up from the :ref:`ao_texture`. + +.. _class_Material3D_constant_FLAG_EMISSION_ON_UV2: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_EMISSION_ON_UV2** = ``12`` + +Use ``UV2`` coordinates to look up from the :ref:`emission_texture`. + +.. _class_Material3D_constant_FLAG_USE_ALPHA_SCISSOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_ALPHA_SCISSOR** = ``13`` + +Use alpha scissor. Set by :ref:`params_use_alpha_scissor`. + +.. _class_Material3D_constant_FLAG_TRIPLANAR_USE_WORLD: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_TRIPLANAR_USE_WORLD** = ``10`` + +Use world coordinates in the triplanar texture lookup instead of local coordinates. + +.. _class_Material3D_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = ``14`` + +Forces the shader to convert albedo from sRGB space to linear space. + +.. _class_Material3D_constant_FLAG_DONT_RECEIVE_SHADOWS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_DONT_RECEIVE_SHADOWS** = ``15`` + +Disables receiving shadows from other objects. + +.. _class_Material3D_constant_FLAG_DISABLE_AMBIENT_LIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_DISABLE_AMBIENT_LIGHT** = ``17`` + +Disables receiving ambient light. + +.. _class_Material3D_constant_FLAG_ENSURE_CORRECT_NORMALS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_ENSURE_CORRECT_NORMALS** = ``16`` + +Ensures that normals appear correct, even with non-uniform scaling. + +.. _class_Material3D_constant_FLAG_USE_SHADOW_TO_OPACITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_USE_SHADOW_TO_OPACITY** = ``18`` + +Enables the shadow to opacity feature. + +.. _class_Material3D_constant_FLAG_ALBEDO_TEXTURE_SDF: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_ALBEDO_TEXTURE_SDF** = ``19`` + +Enables signed distance field rendering shader. + +.. _class_Material3D_constant_FLAG_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_MAX** = ``20`` + +Represents the size of the :ref:`Flags` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_DiffuseMode: + +.. rst-class:: classref-enumeration + +enum **DiffuseMode**: + +.. _class_Material3D_constant_DIFFUSE_BURLEY: + +.. rst-class:: classref-enumeration-constant + +:ref:`DiffuseMode` **DIFFUSE_BURLEY** = ``0`` + +Default diffuse scattering algorithm. + +.. _class_Material3D_constant_DIFFUSE_LAMBERT: + +.. rst-class:: classref-enumeration-constant + +:ref:`DiffuseMode` **DIFFUSE_LAMBERT** = ``1`` + +Diffuse scattering ignores roughness. + +.. _class_Material3D_constant_DIFFUSE_LAMBERT_WRAP: + +.. rst-class:: classref-enumeration-constant + +:ref:`DiffuseMode` **DIFFUSE_LAMBERT_WRAP** = ``2`` + +Extends Lambert to cover more than 90 degrees when roughness increases. + +.. _class_Material3D_constant_DIFFUSE_OREN_NAYAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`DiffuseMode` **DIFFUSE_OREN_NAYAR** = ``3`` + +Attempts to use roughness to emulate microsurfacing. + +.. _class_Material3D_constant_DIFFUSE_TOON: + +.. rst-class:: classref-enumeration-constant + +:ref:`DiffuseMode` **DIFFUSE_TOON** = ``4`` + +Uses a hard cut for lighting, with smoothing affected by roughness. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_SpecularMode: + +.. rst-class:: classref-enumeration + +enum **SpecularMode**: + +.. _class_Material3D_constant_SPECULAR_SCHLICK_GGX: + +.. rst-class:: classref-enumeration-constant + +:ref:`SpecularMode` **SPECULAR_SCHLICK_GGX** = ``0`` + +Default specular blob. + +.. _class_Material3D_constant_SPECULAR_BLINN: + +.. rst-class:: classref-enumeration-constant + +:ref:`SpecularMode` **SPECULAR_BLINN** = ``1`` + +Older specular algorithm, included for compatibility. + +.. _class_Material3D_constant_SPECULAR_PHONG: + +.. rst-class:: classref-enumeration-constant + +:ref:`SpecularMode` **SPECULAR_PHONG** = ``2`` + +Older specular algorithm, included for compatibility. + +.. _class_Material3D_constant_SPECULAR_TOON: + +.. rst-class:: classref-enumeration-constant + +:ref:`SpecularMode` **SPECULAR_TOON** = ``3`` + +Toon blob which changes size based on roughness. + +.. _class_Material3D_constant_SPECULAR_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`SpecularMode` **SPECULAR_DISABLED** = ``4`` + +No specular blob. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_BillboardMode: + +.. rst-class:: classref-enumeration + +enum **BillboardMode**: + +.. _class_Material3D_constant_BILLBOARD_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`BillboardMode` **BILLBOARD_DISABLED** = ``0`` + +Billboard mode is disabled. + +.. _class_Material3D_constant_BILLBOARD_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`BillboardMode` **BILLBOARD_ENABLED** = ``1`` + +The object's Z axis will always face the camera. + +.. _class_Material3D_constant_BILLBOARD_FIXED_Y: + +.. rst-class:: classref-enumeration-constant + +:ref:`BillboardMode` **BILLBOARD_FIXED_Y** = ``2`` + +The object's X axis will always face the camera. + +.. _class_Material3D_constant_BILLBOARD_PARTICLES: + +.. rst-class:: classref-enumeration-constant + +:ref:`BillboardMode` **BILLBOARD_PARTICLES** = ``3`` + +Used for particle systems when assigned to :ref:`Particles` and :ref:`CPUParticles` nodes. Enables ``particles_anim_*`` properties. + +The :ref:`ParticlesMaterial.anim_speed` or :ref:`CPUParticles.anim_speed` should also be set to a positive value for the animation to play. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_TextureChannel: + +.. rst-class:: classref-enumeration + +enum **TextureChannel**: + +.. _class_Material3D_constant_TEXTURE_CHANNEL_RED: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureChannel` **TEXTURE_CHANNEL_RED** = ``0`` + +Used to read from the red channel of a texture. + +.. _class_Material3D_constant_TEXTURE_CHANNEL_GREEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureChannel` **TEXTURE_CHANNEL_GREEN** = ``1`` + +Used to read from the green channel of a texture. + +.. _class_Material3D_constant_TEXTURE_CHANNEL_BLUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureChannel` **TEXTURE_CHANNEL_BLUE** = ``2`` + +Used to read from the blue channel of a texture. + +.. _class_Material3D_constant_TEXTURE_CHANNEL_ALPHA: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureChannel` **TEXTURE_CHANNEL_ALPHA** = ``3`` + +Used to read from the alpha channel of a texture. + +.. _class_Material3D_constant_TEXTURE_CHANNEL_GRAYSCALE: + +.. rst-class:: classref-enumeration-constant + +:ref:`TextureChannel` **TEXTURE_CHANNEL_GRAYSCALE** = ``4`` + +Currently unused. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_EmissionOperator: + +.. rst-class:: classref-enumeration + +enum **EmissionOperator**: + +.. _class_Material3D_constant_EMISSION_OP_ADD: + +.. rst-class:: classref-enumeration-constant + +:ref:`EmissionOperator` **EMISSION_OP_ADD** = ``0`` + +Adds the emission color to the color from the emission texture. + +.. _class_Material3D_constant_EMISSION_OP_MULTIPLY: + +.. rst-class:: classref-enumeration-constant + +:ref:`EmissionOperator` **EMISSION_OP_MULTIPLY** = ``1`` + +Multiplies the emission color by the color from the emission texture. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_DistanceFadeMode: + +.. rst-class:: classref-enumeration + +enum **DistanceFadeMode**: + +.. _class_Material3D_constant_DISTANCE_FADE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`DistanceFadeMode` **DISTANCE_FADE_DISABLED** = ``0`` + +Do not use distance fade. + +.. _class_Material3D_constant_DISTANCE_FADE_PIXEL_ALPHA: + +.. rst-class:: classref-enumeration-constant + +:ref:`DistanceFadeMode` **DISTANCE_FADE_PIXEL_ALPHA** = ``1`` + +Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel. + +.. _class_Material3D_constant_DISTANCE_FADE_PIXEL_DITHER: + +.. rst-class:: classref-enumeration-constant + +:ref:`DistanceFadeMode` **DISTANCE_FADE_PIXEL_DITHER** = ``2`` + +Smoothly fades the object out based on each pixel's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA`. + +.. _class_Material3D_constant_DISTANCE_FADE_OBJECT_DITHER: + +.. rst-class:: classref-enumeration-constant + +:ref:`DistanceFadeMode` **DISTANCE_FADE_OBJECT_DITHER** = ``3`` + +Smoothly fades the object out based on the object's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA`. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Material3D_AsyncMode: + +.. rst-class:: classref-enumeration + +enum **AsyncMode**: + +.. _class_Material3D_constant_ASYNC_MODE_VISIBLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AsyncMode` **ASYNC_MODE_VISIBLE** = ``0`` + +The real conditioned shader needed on each situation will be sent for background compilation. In the meantime, a very complex shader that adapts to every situation will be used ("ubershader"). This ubershader is much slower to render, but will keep the game running without stalling to compile. Once shader compilation is done, the ubershader is replaced by the traditional optimized shader. + +.. _class_Material3D_constant_ASYNC_MODE_HIDDEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AsyncMode` **ASYNC_MODE_HIDDEN** = ``1`` + +Anything with this material applied won't be rendered while this material's shader is being compiled. + +This is useful for optimization, in cases where the visuals won't suffer from having certain non-essential elements missing during the short time their shaders are being compiled. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_Material3D_property_albedo_color: + +.. rst-class:: classref-property + +:ref:`Color` **albedo_color** = ``Color( 1, 1, 1, 1 )`` + +.. rst-class:: classref-property-setget + +- void **set_albedo** **(** :ref:`Color` value **)** +- :ref:`Color` **get_albedo** **(** **)** + +The material's base color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_albedo_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **albedo_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture to multiply by :ref:`albedo_color`. Used for basic texturing of objects. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_anisotropy: + +.. rst-class:: classref-property + +:ref:`float` **anisotropy** + +.. rst-class:: classref-property-setget + +- void **set_anisotropy** **(** :ref:`float` value **)** +- :ref:`float` **get_anisotropy** **(** **)** + +The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_flowmap`'s alpha channel if a texture is defined there and the texture contains an alpha channel. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_anisotropy_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **anisotropy_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections. + +\ **Note:** Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken. + +\ **Note:** Material anisotropy should not to be confused with anisotropic texture filtering. Anisotropic texture filtering can be enabled by selecting a texture in the FileSystem dock, going to the Import dock, checking the **Anisotropic** checkbox then clicking **Reimport**. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/quality/filters/anisotropic_filter_level`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_anisotropy_flowmap: + +.. rst-class:: classref-property + +:ref:`Texture` **anisotropy_flowmap** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion. + +If present, the texture's alpha channel will be used to multiply the strength of the :ref:`anisotropy` effect. Fully opaque pixels will keep the anisotropy effect's original strength while fully transparent pixels will disable the anisotropy effect entirely. The flowmap texture's blue channel is ignored. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_ao_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **ao_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_ao_light_affect: + +.. rst-class:: classref-property + +:ref:`float` **ao_light_affect** + +.. rst-class:: classref-property-setget + +- void **set_ao_light_affect** **(** :ref:`float` value **)** +- :ref:`float` **get_ao_light_affect** **(** **)** + +Amount that ambient occlusion affects lighting from lights. If ``0``, ambient occlusion only affects ambient light. If ``1``, ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_ao_on_uv2: + +.. rst-class:: classref-property + +:ref:`bool` **ao_on_uv2** + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_ao_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **ao_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that defines the amount of ambient occlusion for a given point on the object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_ao_texture_channel: + +.. rst-class:: classref-property + +:ref:`TextureChannel` **ao_texture_channel** + +.. rst-class:: classref-property-setget + +- void **set_ao_texture_channel** **(** :ref:`TextureChannel` value **)** +- :ref:`TextureChannel` **get_ao_texture_channel** **(** **)** + +Specifies the channel of the :ref:`ao_texture` in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_async_mode: + +.. rst-class:: classref-property + +:ref:`AsyncMode` **async_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_async_mode** **(** :ref:`AsyncMode` value **)** +- :ref:`AsyncMode` **get_async_mode** **(** **)** + +If :ref:`ProjectSettings.rendering/gles3/shaders/shader_compilation_mode` is ``Synchronous`` (with or without cache), this determines how this material must behave in regards to asynchronous shader compilation. + +\ :ref:`ASYNC_MODE_VISIBLE` is the default and the best for most cases. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_clearcoat: + +.. rst-class:: classref-property + +:ref:`float` **clearcoat** + +.. rst-class:: classref-property-setget + +- void **set_clearcoat** **(** :ref:`float` value **)** +- :ref:`float` **get_clearcoat** **(** **)** + +Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_clearcoat_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **clearcoat_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough. + +\ **Note:** Clearcoat rendering is not visible if the material has :ref:`flags_unshaded` set to ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_clearcoat_gloss: + +.. rst-class:: classref-property + +:ref:`float` **clearcoat_gloss** + +.. rst-class:: classref-property-setget + +- void **set_clearcoat_gloss** **(** :ref:`float` value **)** +- :ref:`float` **get_clearcoat_gloss** **(** **)** + +Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_clearcoat_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **clearcoat_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_deep_parallax: + +.. rst-class:: classref-property + +:ref:`bool` **depth_deep_parallax** + +.. rst-class:: classref-property-setget + +- void **set_depth_deep_parallax** **(** :ref:`bool` value **)** +- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** + +If ``true``, the shader will read depth texture at multiple points along the view ray to determine occlusion and parrallax. This can be very performance demanding, but results in more realistic looking depth mapping. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **depth_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also :ref:`normal_enabled`. + +\ **Note:** Depth mapping is not supported if triplanar mapping is used on the same material. The value of :ref:`depth_enabled` will be ignored if :ref:`uv1_triplanar` is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_flip_binormal: + +.. rst-class:: classref-property + +:ref:`bool` **depth_flip_binormal** + +.. rst-class:: classref-property-setget + +- void **set_depth_deep_parallax_flip_binormal** **(** :ref:`bool` value **)** +- :ref:`bool` **get_depth_deep_parallax_flip_binormal** **(** **)** + +If ``true``, direction of the binormal is flipped before using in the depth effect. This may be necessary if you have encoded your binormals in a way that is conflicting with the depth effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_flip_tangent: + +.. rst-class:: classref-property + +:ref:`bool` **depth_flip_tangent** + +.. rst-class:: classref-property-setget + +- void **set_depth_deep_parallax_flip_tangent** **(** :ref:`bool` value **)** +- :ref:`bool` **get_depth_deep_parallax_flip_tangent** **(** **)** + +If ``true``, direction of the tangent is flipped before using in the depth effect. This may be necessary if you have encoded your tangents in a way that is conflicting with the depth effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_max_layers: + +.. rst-class:: classref-property + +:ref:`int` **depth_max_layers** + +.. rst-class:: classref-property-setget + +- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` value **)** +- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** + +Number of layers to use when using :ref:`depth_deep_parallax` and the view direction is perpendicular to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_min_layers: + +.. rst-class:: classref-property + +:ref:`int` **depth_min_layers** + +.. rst-class:: classref-property-setget + +- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` value **)** +- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** + +Number of layers to use when using :ref:`depth_deep_parallax` and the view direction is parallel to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_scale: + +.. rst-class:: classref-property + +:ref:`float` **depth_scale** + +.. rst-class:: classref-property-setget + +- void **set_depth_scale** **(** :ref:`float` value **)** +- :ref:`float` **get_depth_scale** **(** **)** + +Scales the depth offset effect. A higher number will create a larger depth. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_depth_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **depth_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to determine depth at a given pixel. Depth is always stored in the red channel. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_albedo: + +.. rst-class:: classref-property + +:ref:`Texture` **detail_albedo** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that specifies the color of the detail overlay. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_blend_mode: + +.. rst-class:: classref-property + +:ref:`BlendMode` **detail_blend_mode** + +.. rst-class:: classref-property-setget + +- void **set_detail_blend_mode** **(** :ref:`BlendMode` value **)** +- :ref:`BlendMode` **get_detail_blend_mode** **(** **)** + +Specifies how the :ref:`detail_albedo` should blend with the current ``ALBEDO``. See :ref:`BlendMode` for options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **detail_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on :ref:`detail_mask`. This can be used to add variation to objects, or to blend between two different albedo/normal textures. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_mask: + +.. rst-class:: classref-property + +:ref:`Texture` **detail_mask** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to specify how the detail textures get blended with the base textures. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_normal: + +.. rst-class:: classref-property + +:ref:`Texture` **detail_normal** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that specifies the per-pixel normal of the detail overlay. + +\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_detail_uv_layer: + +.. rst-class:: classref-property + +:ref:`DetailUV` **detail_uv_layer** + +.. rst-class:: classref-property-setget + +- void **set_detail_uv** **(** :ref:`DetailUV` value **)** +- :ref:`DetailUV` **get_detail_uv** **(** **)** + +Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV` for options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_distance_fade_max_distance: + +.. rst-class:: classref-property + +:ref:`float` **distance_fade_max_distance** + +.. rst-class:: classref-property-setget + +- void **set_distance_fade_max_distance** **(** :ref:`float` value **)** +- :ref:`float` **get_distance_fade_max_distance** **(** **)** + +Distance at which the object appears fully opaque. + +\ **Note:** If ``distance_fade_max_distance`` is less than ``distance_fade_min_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_distance_fade_min_distance: + +.. rst-class:: classref-property + +:ref:`float` **distance_fade_min_distance** + +.. rst-class:: classref-property-setget + +- void **set_distance_fade_min_distance** **(** :ref:`float` value **)** +- :ref:`float` **get_distance_fade_min_distance** **(** **)** + +Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible. + +\ **Note:** If ``distance_fade_min_distance`` is greater than ``distance_fade_max_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_distance_fade_mode: + +.. rst-class:: classref-property + +:ref:`DistanceFadeMode` **distance_fade_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_distance_fade** **(** :ref:`DistanceFadeMode` value **)** +- :ref:`DistanceFadeMode` **get_distance_fade** **(** **)** + +Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode`\ s. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission: + +.. rst-class:: classref-property + +:ref:`Color` **emission** + +.. rst-class:: classref-property-setget + +- void **set_emission** **(** :ref:`Color` value **)** +- :ref:`Color` **get_emission** **(** **)** + +The emitted light's color. See :ref:`emission_enabled`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **emission_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a :ref:`GIProbe` or :ref:`BakedLightmap` is used and this object is used in baked lighting. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission_energy: + +.. rst-class:: classref-property + +:ref:`float` **emission_energy** + +.. rst-class:: classref-property-setget + +- void **set_emission_energy** **(** :ref:`float` value **)** +- :ref:`float` **get_emission_energy** **(** **)** + +The emitted light's strength. See :ref:`emission_enabled`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission_on_uv2: + +.. rst-class:: classref-property + +:ref:`bool` **emission_on_uv2** + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +Use ``UV2`` to read from the :ref:`emission_texture`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission_operator: + +.. rst-class:: classref-property + +:ref:`EmissionOperator` **emission_operator** + +.. rst-class:: classref-property-setget + +- void **set_emission_operator** **(** :ref:`EmissionOperator` value **)** +- :ref:`EmissionOperator` **get_emission_operator** **(** **)** + +Sets how :ref:`emission` interacts with :ref:`emission_texture`. Can either add or multiply. See :ref:`EmissionOperator` for options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_emission_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **emission_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that specifies how much surface emits light at a given point. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_albedo_tex_force_srgb: + +.. rst-class:: classref-property + +:ref:`bool` **flags_albedo_tex_force_srgb** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +Forces a conversion of the :ref:`albedo_texture` from sRGB space to linear space. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_albedo_tex_msdf: + +.. rst-class:: classref-property + +:ref:`bool` **flags_albedo_tex_msdf** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +Enables signed distance field rendering shader. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_disable_ambient_light: + +.. rst-class:: classref-property + +:ref:`bool` **flags_disable_ambient_light** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the object receives no ambient light. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_do_not_receive_shadows: + +.. rst-class:: classref-property + +:ref:`bool` **flags_do_not_receive_shadows** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the object receives no shadow that would otherwise be cast onto it. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_ensure_correct_normals: + +.. rst-class:: classref-property + +:ref:`bool` **flags_ensure_correct_normals** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the shader will compute extra operations to make sure the normal stays correct when using a non-uniform scale. Only enable if using non-uniform scaling. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_fixed_size: + +.. rst-class:: classref-property + +:ref:`bool` **flags_fixed_size** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the object is rendered at the same size regardless of distance. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_no_depth_test: + +.. rst-class:: classref-property + +:ref:`bool` **flags_no_depth_test** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, depth testing is disabled and the object will be drawn in render order. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_transparent: + +.. rst-class:: classref-property + +:ref:`bool` **flags_transparent** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, transparency is enabled on the body. See also :ref:`params_blend_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_unshaded: + +.. rst-class:: classref-property + +:ref:`bool` **flags_unshaded** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the object is unaffected by lighting. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_use_point_size: + +.. rst-class:: classref-property + +:ref:`bool` **flags_use_point_size** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, render point size can be changed. + +\ **Note:** This is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_use_shadow_to_opacity: + +.. rst-class:: classref-property + +:ref:`bool` **flags_use_shadow_to_opacity** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_vertex_lighting: + +.. rst-class:: classref-property + +:ref:`bool` **flags_vertex_lighting** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices, especially for meshes with a lower polygon count. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled. + +See also :ref:`ProjectSettings.rendering/quality/shading/force_vertex_shading` which can globally enable vertex shading on all materials. + +\ **Note:** By default, vertex shading is enforced on mobile platforms by :ref:`ProjectSettings.rendering/quality/shading/force_vertex_shading`'s ``mobile`` override. + +\ **Note:** :ref:`flags_vertex_lighting` has no effect if :ref:`flags_unshaded` is ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_flags_world_triplanar: + +.. rst-class:: classref-property + +:ref:`bool` **flags_world_triplanar** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_metallic: + +.. rst-class:: classref-property + +:ref:`float` **metallic** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_metallic** **(** :ref:`float` value **)** +- :ref:`float` **get_metallic** **(** **)** + +A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between ``0`` and ``1`` should only be used for blending between metal and non-metal sections. To alter the amount of reflection use :ref:`roughness`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_metallic_specular: + +.. rst-class:: classref-property + +:ref:`float` **metallic_specular** = ``0.5`` + +.. rst-class:: classref-property-setget + +- void **set_specular** **(** :ref:`float` value **)** +- :ref:`float` **get_specular** **(** **)** + +Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources. + +\ **Note:** Unlike :ref:`metallic`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_metallic_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **metallic_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to specify metallic for an object. This is multiplied by :ref:`metallic`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_metallic_texture_channel: + +.. rst-class:: classref-property + +:ref:`TextureChannel` **metallic_texture_channel** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_metallic_texture_channel** **(** :ref:`TextureChannel` value **)** +- :ref:`TextureChannel` **get_metallic_texture_channel** **(** **)** + +Specifies the channel of the :ref:`metallic_texture` in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_normal_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **normal_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, normal mapping is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_normal_scale: + +.. rst-class:: classref-property + +:ref:`float` **normal_scale** + +.. rst-class:: classref-property-setget + +- void **set_normal_scale** **(** :ref:`float` value **)** +- :ref:`float` **get_normal_scale** **(** **)** + +The strength of the normal map's effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_normal_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **normal_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to specify the normal at a given pixel. The ``normal_texture`` only uses the red and green channels; the blue and alpha channels are ignored. The normal read from ``normal_texture`` is oriented around the surface normal provided by the :ref:`Mesh`. + +\ **Note:** The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with :ref:`SurfaceTool`, you can use :ref:`SurfaceTool.generate_normals` and :ref:`SurfaceTool.generate_tangents` to automatically generate normals and tangents respectively. + +\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_orm_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **orm_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +A single texture that combines information about AO, roughness and metallic. AO is stored in the red channel, roughness in the green channel and metallic in the blue channel. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_alpha_scissor_threshold: + +.. rst-class:: classref-property + +:ref:`float` **params_alpha_scissor_threshold** + +.. rst-class:: classref-property-setget + +- void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** +- :ref:`float` **get_alpha_scissor_threshold** **(** **)** + +Threshold at which the alpha scissor will discard values. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_billboard_keep_scale: + +.. rst-class:: classref-property + +:ref:`bool` **params_billboard_keep_scale** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`params_billboard_mode` is :ref:`BILLBOARD_ENABLED`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_billboard_mode: + +.. rst-class:: classref-property + +:ref:`BillboardMode` **params_billboard_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** +- :ref:`BillboardMode` **get_billboard_mode** **(** **)** + +Controls how the object faces the camera. See :ref:`BillboardMode`. + +\ **Note:** Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See `GitHub issue #41567 `__ for details. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_blend_mode: + +.. rst-class:: classref-property + +:ref:`BlendMode` **params_blend_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_blend_mode** **(** :ref:`BlendMode` value **)** +- :ref:`BlendMode` **get_blend_mode** **(** **)** + +The material's blend mode. + +\ **Note:** Values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_cull_mode: + +.. rst-class:: classref-property + +:ref:`CullMode` **params_cull_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_cull_mode** **(** :ref:`CullMode` value **)** +- :ref:`CullMode` **get_cull_mode** **(** **)** + +Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_depth_draw_mode: + +.. rst-class:: classref-property + +:ref:`DepthDrawMode` **params_depth_draw_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_depth_draw_mode** **(** :ref:`DepthDrawMode` value **)** +- :ref:`DepthDrawMode` **get_depth_draw_mode** **(** **)** + +Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_diffuse_mode: + +.. rst-class:: classref-property + +:ref:`DiffuseMode` **params_diffuse_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_diffuse_mode** **(** :ref:`DiffuseMode` value **)** +- :ref:`DiffuseMode` **get_diffuse_mode** **(** **)** + +The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_grow: + +.. rst-class:: classref-property + +:ref:`bool` **params_grow** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_grow_enabled** **(** :ref:`bool` value **)** +- :ref:`bool` **is_grow_enabled** **(** **)** + +If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_grow_amount: + +.. rst-class:: classref-property + +:ref:`float` **params_grow_amount** + +.. rst-class:: classref-property-setget + +- void **set_grow** **(** :ref:`float` value **)** +- :ref:`float` **get_grow** **(** **)** + +Grows object vertices in the direction of their normals. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_line_width: + +.. rst-class:: classref-property + +:ref:`float` **params_line_width** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_line_width** **(** :ref:`float` value **)** +- :ref:`float` **get_line_width** **(** **)** + +Currently unimplemented in Godot. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_point_size: + +.. rst-class:: classref-property + +:ref:`float` **params_point_size** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_point_size** **(** :ref:`float` value **)** +- :ref:`float` **get_point_size** **(** **)** + +The point size in pixels. See :ref:`flags_use_point_size`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_specular_mode: + +.. rst-class:: classref-property + +:ref:`SpecularMode` **params_specular_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_specular_mode** **(** :ref:`SpecularMode` value **)** +- :ref:`SpecularMode` **get_specular_mode** **(** **)** + +The method for rendering the specular blob. See :ref:`SpecularMode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_params_use_alpha_scissor: + +.. rst-class:: classref-property + +:ref:`bool` **params_use_alpha_scissor** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the shader will discard all pixels that have an alpha value less than :ref:`params_alpha_scissor_threshold`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_particles_anim_h_frames: + +.. rst-class:: classref-property + +:ref:`int` **particles_anim_h_frames** + +.. rst-class:: classref-property-setget + +- void **set_particles_anim_h_frames** **(** :ref:`int` value **)** +- :ref:`int` **get_particles_anim_h_frames** **(** **)** + +The number of horizontal frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_particles_anim_loop: + +.. rst-class:: classref-property + +:ref:`bool` **particles_anim_loop** + +.. rst-class:: classref-property-setget + +- void **set_particles_anim_loop** **(** :ref:`bool` value **)** +- :ref:`bool` **get_particles_anim_loop** **(** **)** + +If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_particles_anim_v_frames: + +.. rst-class:: classref-property + +:ref:`int` **particles_anim_v_frames** + +.. rst-class:: classref-property-setget + +- void **set_particles_anim_v_frames** **(** :ref:`int` value **)** +- :ref:`int` **get_particles_anim_v_frames** **(** **)** + +The number of vertical frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_proximity_fade_distance: + +.. rst-class:: classref-property + +:ref:`float` **proximity_fade_distance** + +.. rst-class:: classref-property-setget + +- void **set_proximity_fade_distance** **(** :ref:`float` value **)** +- :ref:`float` **get_proximity_fade_distance** **(** **)** + +Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_proximity_fade_enable: + +.. rst-class:: classref-property + +:ref:`bool` **proximity_fade_enable** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_proximity_fade** **(** :ref:`bool` value **)** +- :ref:`bool` **is_proximity_fade_enabled** **(** **)** + +If ``true``, the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_refraction_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **refraction_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, the refraction effect is enabled. Refraction distorts transparency based on light from behind the object. When using the GLES3 backend, the material's roughness value will affect the blurriness of the refraction. Higher roughness values will make the refraction look blurrier. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_refraction_scale: + +.. rst-class:: classref-property + +:ref:`float` **refraction_scale** + +.. rst-class:: classref-property-setget + +- void **set_refraction** **(** :ref:`float` value **)** +- :ref:`float` **get_refraction** **(** **)** + +The strength of the refraction effect. Higher values result in a more distorted appearance for the refraction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_refraction_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **refraction_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_refraction_texture_channel: + +.. rst-class:: classref-property + +:ref:`TextureChannel` **refraction_texture_channel** + +.. rst-class:: classref-property-setget + +- void **set_refraction_texture_channel** **(** :ref:`TextureChannel` value **)** +- :ref:`TextureChannel` **get_refraction_texture_channel** **(** **)** + +Specifies the channel of the :ref:`refraction_texture` in which the refraction information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_rim: + +.. rst-class:: classref-property + +:ref:`float` **rim** + +.. rst-class:: classref-property-setget + +- void **set_rim** **(** :ref:`float` value **)** +- :ref:`float` **get_rim** **(** **)** + +Sets the strength of the rim lighting effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_rim_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **rim_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. + +\ **Note:** Rim lighting is not visible if the material has :ref:`flags_unshaded` set to ``true``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_rim_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **rim_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_rim_tint: + +.. rst-class:: classref-property + +:ref:`float` **rim_tint** + +.. rst-class:: classref-property-setget + +- void **set_rim_tint** **(** :ref:`float` value **)** +- :ref:`float` **get_rim_tint** **(** **)** + +The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_roughness: + +.. rst-class:: classref-property + +:ref:`float` **roughness** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_roughness** **(** :ref:`float` value **)** +- :ref:`float` **get_roughness** **(** **)** + +Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_roughness_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **roughness_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_roughness_texture_channel: + +.. rst-class:: classref-property + +:ref:`TextureChannel` **roughness_texture_channel** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_roughness_texture_channel** **(** :ref:`TextureChannel` value **)** +- :ref:`TextureChannel` **get_roughness_texture_channel** **(** **)** + +Specifies the channel of the :ref:`ao_texture` in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_subsurf_scatter_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **subsurf_scatter_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_subsurf_scatter_strength: + +.. rst-class:: classref-property + +:ref:`float` **subsurf_scatter_strength** + +.. rst-class:: classref-property-setget + +- void **set_subsurface_scattering_strength** **(** :ref:`float` value **)** +- :ref:`float` **get_subsurface_scattering_strength** **(** **)** + +The strength of the subsurface scattering effect. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_subsurf_scatter_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **subsurf_scatter_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_transmission: + +.. rst-class:: classref-property + +:ref:`Color` **transmission** + +.. rst-class:: classref-property-setget + +- void **set_transmission** **(** :ref:`Color` value **)** +- :ref:`Color` **get_transmission** **(** **)** + +The color used by the transmission effect. Represents the light passing through an object. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_transmission_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **transmission_enabled** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +If ``true``, the transmission effect is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_transmission_texture: + +.. rst-class:: classref-property + +:ref:`Texture` **transmission_texture** + +.. rst-class:: classref-property-setget + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** +- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Texture used to control the transmission effect per-pixel. Added to :ref:`transmission`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv1_offset: + +.. rst-class:: classref-property + +:ref:`Vector3` **uv1_offset** = ``Vector3( 0, 0, 0 )`` + +.. rst-class:: classref-property-setget + +- void **set_uv1_offset** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_uv1_offset** **(** **)** + +How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` in the vertex function. This can be used to offset a texture. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv1_scale: + +.. rst-class:: classref-property + +:ref:`Vector3` **uv1_scale** = ``Vector3( 1, 1, 1 )`` + +.. rst-class:: classref-property-setget + +- void **set_uv1_scale** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_uv1_scale** **(** **)** + +How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv1_triplanar: + +.. rst-class:: classref-property + +:ref:`bool` **uv1_triplanar** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, instead of using ``UV`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv1_triplanar_sharpness: + +.. rst-class:: classref-property + +:ref:`float` **uv1_triplanar_sharpness** + +.. rst-class:: classref-property-setget + +- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` value **)** +- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** + +A lower number blends the texture more softly while a higher number blends the texture more sharply. + +\ **Note:** :ref:`uv1_triplanar_sharpness` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv2_offset: + +.. rst-class:: classref-property + +:ref:`Vector3` **uv2_offset** = ``Vector3( 0, 0, 0 )`` + +.. rst-class:: classref-property-setget + +- void **set_uv2_offset** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_uv2_offset** **(** **)** + +How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` in the vertex function. This can be used to offset a texture. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv2_scale: + +.. rst-class:: classref-property + +:ref:`Vector3` **uv2_scale** = ``Vector3( 1, 1, 1 )`` + +.. rst-class:: classref-property-setget + +- void **set_uv2_scale** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_uv2_scale** **(** **)** + +How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv2_triplanar: + +.. rst-class:: classref-property + +:ref:`bool` **uv2_triplanar** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, instead of using ``UV2`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_uv2_triplanar_sharpness: + +.. rst-class:: classref-property + +:ref:`float` **uv2_triplanar_sharpness** + +.. rst-class:: classref-property-setget + +- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` value **)** +- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** + +A lower number blends the texture more softly while a higher number blends the texture more sharply. + +\ **Note:** :ref:`uv2_triplanar_sharpness` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_vertex_color_is_srgb: + +.. rst-class:: classref-property + +:ref:`bool` **vertex_color_is_srgb** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the model's vertex colors are processed as sRGB mode. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_property_vertex_color_use_as_albedo: + +.. rst-class:: classref-property + +:ref:`bool` **vertex_color_use_as_albedo** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +If ``true``, the vertex color is used as albedo color. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_Material3D_method_get_feature: + +.. rst-class:: classref-method + +:ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| + +Returns ``true``, if the specified :ref:`Feature` is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_method_get_flag: + +.. rst-class:: classref-method + +:ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| + +Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_method_get_texture: + +.. rst-class:: classref-method + +:ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| + +Returns the :ref:`Texture` associated with the specified :ref:`TextureParam`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_method_set_feature: + +.. rst-class:: classref-method + +void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** + +If ``true``, enables the specified :ref:`Feature`. Many features that are available in :ref:`SpatialMaterial`\ 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``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_method_set_flag: + +.. rst-class:: classref-method + +void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** + +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. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Material3D_method_set_texture: + +.. rst-class:: classref-method + +void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** + +Sets the :ref:`Texture` to be used by the specified :ref:`TextureParam`. This function is called when setting members ending in ``*_texture``. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 49ee0a484..c1016e9cb 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MenuButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MenuButton.xml. .. _class_MenuButton: diff --git a/classes/class_mergegroup.rst b/classes/class_mergegroup.rst new file mode 100644 index 000000000..5742a2bb7 --- /dev/null +++ b/classes/class_mergegroup.rst @@ -0,0 +1,320 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MergeGroup.xml. + +.. _class_MergeGroup: + +MergeGroup +========== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +MergeGroups allow merging of suitable meshes, which can enhance performance. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**MergeGroup** is a way of grouping nodes into logical blocks that contain meshes that are suitable for joining together, in order to increase rendering efficiency and reduce the number of nodes to simplify the scene. + +Only children and descendants will be considered for merging. **MergeGroup** has no effect on parents or siblings. + +Meshes must be static (non-moving) in relation to one another to be joined. For instance, a level background is often intended to be static. However, logical blocks that **move** together, such as a ship, or car, are also good candidates for merging. + +Within these blocks you will often want to prevent certain nodes or branches from being merged, because they **are** intended to move, or change visibility, in relation to the main block. An example might be a steering wheel on a ship. You can finely control this with :ref:`Spatial.merging_mode`. Be aware that :ref:`Spatial.merging_mode` will be inherited from parents and ancestors of the **MergeGroup**. + +There are two ways of performing merging: + +- At runtime, using :ref:`merge_meshes` or :ref:`auto_merge`. + +- Baking at design time to a separate scene, using the ``bake`` button in the Editor inspector. + +Merging at runtime is usually best, because it is non-destructive, and will minimize the binary size of the ``pck`` file. It can however take a small amount of time to merge the meshes (usually during level load), but this will usually be well under a second. + +Baking ahead of time allows fastest possible load times, but it is by nature a *destructive* operation - you should keep a copy of the source scene for later editing, because you cannot reconstruct an unmerged scene from a baked scene. It can also bloat the size of the ``pck`` file considerably, as for example storing 10 merged trees will have 10x the geometry of the scene before merging. + +On the other hand, baking ahead of time is very useful for previewing what will happen after merging, and diagnosing problems. It is also convenient for some workflows such as constructing a scene out of merged modular units. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+-------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`auto_merge` | ``true`` | + +-------------------------+-------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`shadow_proxy` | ``true`` | + +-------------------------+-------------------------------------------------------------+----------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_param` **(** :ref:`Param` param **)** | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_param_enabled` **(** :ref:`ParamEnabled` param **)** | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`merge_meshes` **(** **)** | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_param` **(** :ref:`Param` param, :ref:`int` value **)** | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_param_enabled` **(** :ref:`ParamEnabled` param, :ref:`bool` value **)** | + +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_MergeGroup_ParamEnabled: + +.. rst-class:: classref-enumeration + +enum **ParamEnabled**: + +.. _class_MergeGroup_constant_PARAM_ENABLED_AUTO_MERGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_AUTO_MERGE** = ``0`` + +Activates merging automatically when the **MergeGroup** enters the scene (usually during loading). + +Alternatively you can switch this off and use :ref:`merge_meshes` to manually activate merging. + +.. _class_MergeGroup_constant_PARAM_ENABLED_SHADOW_PROXY: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_SHADOW_PROXY** = ``1`` + +If ``true``, a **shadow proxy** will be generated. This is a merged mesh that is a duplicate of the existing opaque geometry, set to cast shadows only. The source meshes will have shadow casting switched off. + +This can be more efficient for rendering shadows, because the requirements for merging a **shadow mesh** are far lower than for regular merging. Providing materials are opaque, meshes with different materials can often be merged together for the purposes of shadow casting. This can reduce drawcalls. + +\ **Tip:** Try running with and without a **shadow proxy** and measure performance, sometimes it will be faster, sometimes not. + +.. _class_MergeGroup_constant_PARAM_ENABLED_CONVERT_CSGS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_CONVERT_CSGS** = ``2`` + +If ``true``, ``CSG`` nodes will be converted to :ref:`MeshInstance`\ s. These :ref:`MeshInstance`\ s can then be merged if suitable matches are found. + +.. _class_MergeGroup_constant_PARAM_ENABLED_CONVERT_GRIDMAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_CONVERT_GRIDMAPS** = ``3`` + +If ``true``, :ref:`GridMap`\ s will be converted to :ref:`MeshInstance`\ s. These :ref:`MeshInstance`\ s can then be merged if suitable matches are found. + +\ **Note:** :ref:`GridMap`\ s are usually rendered as :ref:`MultiMesh`\ es very efficiently, so converting these will often be counterproductive. Exceptions include when using the ``GLES2`` backend, which can be inefficient at rendering :ref:`MultiMesh`. + +.. _class_MergeGroup_constant_PARAM_ENABLED_COMBINE_SURFACES: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_COMBINE_SURFACES** = ``4`` + +If ``true``, as a final step, matching :ref:`MeshInstance`\ s can be joined by combining their surfaces to form an *"uber mesh instance"*. + +While this is convenient, it does have the downside that all the constituent meshes will be culled as one unit, which can make culling less efficient in some situations. + +.. _class_MergeGroup_constant_PARAM_ENABLED_CLEAN_MESHES: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParamEnabled` **PARAM_ENABLED_CLEAN_MESHES** = ``5`` + +Cleans and removes degenerate triangles from meshes, which can make them more suitable for later processing, such as generating secondary UVs for lightmapping. + +\ **Note:** This step can be slow and should typically only be used when *baking* the **MergeGroup**. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_MergeGroup_Param: + +.. rst-class:: classref-enumeration + +enum **Param**: + +.. _class_MergeGroup_constant_PARAM_GROUP_SIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Param` **PARAM_GROUP_SIZE** = ``0`` + +When set to ``0``, all matching meshes will be merged within the **MergeGroup**. + +If set to ``1`` or above, only groups of a maximum of ``group_size`` meshes will be merged together. These groups will be chosen by locality. This enables getting some of the benefits of merging, while still allowing some culling to take place. + +\ **Tip:** Use *baking* to preview what the scene will look like after merging. + +.. _class_MergeGroup_constant_PARAM_SPLITS_HORIZONTAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Param` **PARAM_SPLITS_HORIZONTAL** = ``1`` + +When set to a value above ``1``, mesh geometry will be *split by locality* into a grid of :ref:`MeshInstance`\ s. + +For instance a value of ``2`` will split meshes into a grid of 2x2 (on the ``x`` and ``z`` axes), for greater culling efficiency. + +\ **Note:** Greater culling efficiency must be balanced against a greater number of drawcalls. + +.. _class_MergeGroup_constant_PARAM_SPLITS_VERTICAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Param` **PARAM_SPLITS_VERTICAL** = ``2`` + +This setting acts exactly as :ref:`PARAM_SPLITS_HORIZONTAL`, except it determines the grid split on the vertical axis. + +A grid with :ref:`PARAM_SPLITS_HORIZONTAL` ``3``, and :ref:`PARAM_SPLITS_VERTICAL` ``2`` will produce a grid of 3x2x3 (on the ``x`` and ``y`` and ``z`` axes respectively). + +.. _class_MergeGroup_constant_PARAM_MIN_SPLIT_POLY_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Param` **PARAM_MIN_SPLIT_POLY_COUNT** = ``3`` + +When using *split by locality* using :ref:`PARAM_SPLITS_HORIZONTAL` and / or :ref:`PARAM_SPLITS_VERTICAL`, you can specify that the split will only occur for meshes above this specified poly count. + +There is often little to gain by splitting meshes with low poly count. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_MergeGroup_property_auto_merge: + +.. rst-class:: classref-property + +:ref:`bool` **auto_merge** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_param_enabled** **(** :ref:`ParamEnabled` param, :ref:`bool` value **)** +- :ref:`bool` **get_param_enabled** **(** :ref:`ParamEnabled` param **)** + +Activates merging automatically when the **MergeGroup** enters the scene (usually during loading). + +Alternatively you can switch this off and use :ref:`merge_meshes` to manually activate merging. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MergeGroup_property_shadow_proxy: + +.. rst-class:: classref-property + +:ref:`bool` **shadow_proxy** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_param_enabled** **(** :ref:`ParamEnabled` param, :ref:`bool` value **)** +- :ref:`bool` **get_param_enabled** **(** :ref:`ParamEnabled` param **)** + +If ``true``, a **shadow proxy** will be generated. This is a merged mesh that is a duplicate of the existing opaque geometry, set to cast shadows only. The source meshes will have shadow casting switched off. + +This can be more efficient for rendering shadows, because the requirements for merging a **shadow mesh** are far lower than for regular merging. Providing materials are opaque, meshes with different materials can often be merged together for the purposes of shadow casting. This can reduce drawcalls. + +\ **Tip:** Try running with and without a **shadow proxy** and measure performance, sometimes it will be faster, sometimes not. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_MergeGroup_method_get_param: + +.. rst-class:: classref-method + +:ref:`int` **get_param** **(** :ref:`Param` param **)** + +Returns the value of the specified :ref:`Param` parameter. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MergeGroup_method_get_param_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **get_param_enabled** **(** :ref:`ParamEnabled` param **)** + +Gets the value of the specified :ref:`ParamEnabled` parameter. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MergeGroup_method_merge_meshes: + +.. rst-class:: classref-method + +void **merge_meshes** **(** **)** + +You can choose to either automatically merge when the **MergeGroup** enters the scene (usually during loading) using :ref:`auto_merge`, or you can manually trigger merging by calling this function. + +Manually activating merging is especially useful when you are *procedurally generating* your level, and when you want to set advanced parameters prior to merging at runtime. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MergeGroup_method_set_param: + +.. rst-class:: classref-method + +void **set_param** **(** :ref:`Param` param, :ref:`int` value **)** + +Sets the value of the specified :ref:`Param` parameter. + +.. rst-class:: classref-item-separator + +---- + +.. _class_MergeGroup_method_set_param_enabled: + +.. rst-class:: classref-method + +void **set_param_enabled** **(** :ref:`ParamEnabled` param, :ref:`bool` value **)** + +Sets the value of the specified :ref:`ParamEnabled` parameter. + +.. |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.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index f134af924..48eca2390 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Mesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Mesh.xml. .. _class_Mesh: @@ -365,6 +365,16 @@ Flag used to mark that the array uses 16-bit bones instead of 8-bit. Flag used to mark that the array uses an octahedral representation of normal and tangent vectors rather than cartesian. +.. _class_Mesh_constant_ARRAY_FLAG_USE_VERTEX_CACHE_OPTIMIZATION: + +.. rst-class:: classref-enumeration-constant + +:ref:`ArrayFormat` **ARRAY_FLAG_USE_VERTEX_CACHE_OPTIMIZATION** = ``4194304`` + +Flag used to request vertex cache optimization. + +This re-orders indices in order to make best use of GPU vertex caches, which can improve rendering performance particularly with high poly models. + .. _class_Mesh_constant_ARRAY_COMPRESS_DEFAULT: .. rst-class:: classref-enumeration-constant diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 66e652832..07671eefb 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshDataTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MeshDataTool.xml. .. _class_MeshDataTool: diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 19b362416..2fc79d045 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MeshInstance.xml. .. _class_MeshInstance: @@ -62,27 +62,27 @@ Methods .. table:: :widths: auto - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_convex_collision` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_debug_tangents` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_multiple_convex_collisions` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`create_trimesh_collision` **(** **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_active_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_surface_material_count` **(** **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_mergeable_with` **(** :ref:`Node` other_mesh_instance **)** |const| | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`merge_meshes` **(** :ref:`Array` mesh_instances=[ ], :ref:`bool` use_global_space=false, :ref:`bool` check_compatibility=true **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_convex_collision` **(** :ref:`bool` clean=true, :ref:`bool` simplify=false **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_debug_tangents` **(** **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_multiple_convex_collisions` **(** **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`create_trimesh_collision` **(** **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_active_material` **(** :ref:`int` surface **)** |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_surface_material_count` **(** **)** |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_mergeable_with` **(** :ref:`Node` other_mesh_instance, :ref:`bool` shadows_only=false **)** |const| | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`merge_meshes` **(** :ref:`Array` mesh_instances, :ref:`bool` use_global_space=false, :ref:`bool` check_compatibility=true, :ref:`bool` shadows_only=false **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | + +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -262,7 +262,7 @@ Returns the number of surface override materials. .. rst-class:: classref-method -:ref:`bool` **is_mergeable_with** **(** :ref:`Node` other_mesh_instance **)** |const| +:ref:`bool` **is_mergeable_with** **(** :ref:`Node` other_mesh_instance, :ref:`bool` shadows_only=false **)** |const| Returns ``true`` if this **MeshInstance** can be merged with the specified ``other_mesh_instance``, using the :ref:`merge_meshes` function. @@ -276,7 +276,7 @@ In order to be mergeable, properties of the **MeshInstance** must match, and eac .. rst-class:: classref-method -:ref:`bool` **merge_meshes** **(** :ref:`Array` mesh_instances=[ ], :ref:`bool` use_global_space=false, :ref:`bool` check_compatibility=true **)** +:ref:`bool` **merge_meshes** **(** :ref:`Array` mesh_instances, :ref:`bool` use_global_space=false, :ref:`bool` check_compatibility=true, :ref:`bool` shadows_only=false **)** This function can merge together the data from several source **MeshInstance**\ s into a single destination **MeshInstance** (the MeshInstance the function is called from). This is primarily useful for improving performance by reducing the number of drawcalls and :ref:`Node`\ s. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 22689213c..985cdbed1 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MeshInstance2D.xml. .. _class_MeshInstance2D: diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 6d05c60fb..3984bb710 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshLibrary.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MeshLibrary.xml. .. _class_MeshLibrary: diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 3a1400912..c3f467dcf 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MeshTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MeshTexture.xml. .. _class_MeshTexture: diff --git a/classes/class_methodtweener.rst b/classes/class_methodtweener.rst index 03c2ca838..a547ca67f 100644 --- a/classes/class_methodtweener.rst +++ b/classes/class_methodtweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MethodTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MethodTweener.xml. .. _class_MethodTweener: diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 20385e79b..9c2033fd4 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/mobile_vr/doc_classes/MobileVRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/mobile_vr/doc_classes/MobileVRInterface.xml. .. _class_MobileVRInterface: diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index ceb404020..7b55ff931 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MultiMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MultiMesh.xml. .. _class_MultiMesh: @@ -470,7 +470,7 @@ void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` is non-``null`` on the **MultiMesh** and :ref:`SpatialMaterial.vertex_color_use_as_albedo` is ``true`` on the material. If the color doesn't look as expected, make sure the material's albedo color is set to pure white (``Color(1, 1, 1)``). +For the color to take effect, ensure that :ref:`color_format` is non-``null`` on the **MultiMesh** and :ref:`Material3D.vertex_color_use_as_albedo` is ``true`` on the material. If the color doesn't look as expected, make sure the material's albedo color is set to pure white (``Color(1, 1, 1)``). .. rst-class:: classref-item-separator diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index e2f38d642..051bb4c1e 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MultiMeshInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MultiMeshInstance.xml. .. _class_MultiMeshInstance: diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index 5c4a4f83c..1d45b8f9e 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MultiMeshInstance2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MultiMeshInstance2D.xml. .. _class_MultiMeshInstance2D: diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 9d1654ce0..de48bbf34 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/MultiplayerAPI.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/MultiplayerAPI.xml. .. _class_MultiplayerAPI: diff --git a/classes/class_multiplayerpeergdnative.rst b/classes/class_multiplayerpeergdnative.rst index fb107b3ed..69c77456e 100644 --- a/classes/class_multiplayerpeergdnative.rst +++ b/classes/class_multiplayerpeergdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/MultiplayerPeerGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/MultiplayerPeerGDNative.xml. .. _class_MultiplayerPeerGDNative: diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index f1b69410e..987dbef31 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Mutex.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Mutex.xml. .. _class_Mutex: @@ -21,6 +21,16 @@ Description A synchronization mutex (mutual exclusion). This is used to synchronize multiple :ref:`Thread`\ s, and is equivalent to a binary :ref:`Semaphore`. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks. +It's of the recursive kind, so it can be locked multiple times by one thread, provided it also unlocks it as many times. + +\ **Warning:**\ + +To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met: + +- By the time a **Mutex**'s reference count reaches zero and therefore it is destroyed, no threads (including the one on which the destruction will happen) must have it locked. + +- By the time a :ref:`Thread`'s reference count reaches zero and therefore it is destroyed, it must not have any mutex locked. + .. rst-class:: classref-introduction-group Tutorials @@ -91,6 +101,8 @@ Unlocks this **Mutex**, leaving it to other threads. \ **Note:** If a thread called :ref:`lock` or :ref:`try_lock` multiple times while already having ownership of the mutex, it must also call :ref:`unlock` the same number of times in order to unlock it correctly. +\ **Warning:** Calling :ref:`unlock` more times that :ref:`lock` on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 48ec4e322..5e4371081 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/NativeScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/NativeScript.xml. .. _class_NativeScript: diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 88c00394b..12c3885ca 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Navigation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Navigation.xml. .. _class_Navigation: diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 7c439cfb1..6d7174695 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Navigation2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Navigation2D.xml. .. _class_Navigation2D: diff --git a/classes/class_navigation2dserver.rst b/classes/class_navigation2dserver.rst index b2123319b..107fbf5c5 100644 --- a/classes/class_navigation2dserver.rst +++ b/classes/class_navigation2dserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Navigation2DServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Navigation2DServer.xml. .. _class_Navigation2DServer: diff --git a/classes/class_navigationagent.rst b/classes/class_navigationagent.rst index fa30d0e92..62ae211fd 100644 --- a/classes/class_navigationagent.rst +++ b/classes/class_navigationagent.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationAgent.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationAgent.xml. .. _class_NavigationAgent: diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index e1f7455e0..8093f4438 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationAgent2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationAgent2D.xml. .. _class_NavigationAgent2D: diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 3a3694d68..a82ec97de 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationMesh.xml. .. _class_NavigationMesh: diff --git a/classes/class_navigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst index 105220f66..014a11eef 100644 --- a/classes/class_navigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationMeshGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationMeshGenerator.xml. .. _class_NavigationMeshGenerator: diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index f8bfab4fd..83427afcf 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationMeshInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationMeshInstance.xml. .. _class_NavigationMeshInstance: diff --git a/classes/class_navigationobstacle.rst b/classes/class_navigationobstacle.rst index bea126599..a1005e8ba 100644 --- a/classes/class_navigationobstacle.rst +++ b/classes/class_navigationobstacle.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationObstacle.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationObstacle.xml. .. _class_NavigationObstacle: diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst index 7871557f5..36902153a 100644 --- a/classes/class_navigationobstacle2d.rst +++ b/classes/class_navigationobstacle2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationObstacle2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationObstacle2D.xml. .. _class_NavigationObstacle2D: diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index b427ea3d3..e301f88b8 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationPolygon.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationPolygon.xml. .. _class_NavigationPolygon: diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index cf67f44d6..21c7e0313 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationPolygonInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationPolygonInstance.xml. .. _class_NavigationPolygonInstance: diff --git a/classes/class_navigationserver.rst b/classes/class_navigationserver.rst index 8c6c64f3d..43076a39e 100644 --- a/classes/class_navigationserver.rst +++ b/classes/class_navigationserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NavigationServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NavigationServer.xml. .. _class_NavigationServer: diff --git a/classes/class_networkedmultiplayercustom.rst b/classes/class_networkedmultiplayercustom.rst index 8cecad06a..7096c30d7 100644 --- a/classes/class_networkedmultiplayercustom.rst +++ b/classes/class_networkedmultiplayercustom.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NetworkedMultiplayerCustom.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NetworkedMultiplayerCustom.xml. .. _class_NetworkedMultiplayerCustom: @@ -56,7 +56,7 @@ Signals **packet_generated** **(** :ref:`int` peer_id, :ref:`PoolByteArray` buffer, :ref:`int` transfer_mode **)** -Emitted when the local :ref:`MultiplayerAPI` generates a packet. +Emitted when the local :ref:`MultiplayerAPI` generates a packet (e.g. when calling :ref:`Node.rpc`). Your script should take this packet and send it to the requested peer over the network (which should call :ref:`deliver_packet` with the data when it's received). @@ -89,7 +89,7 @@ When your script receives a packet from other peers over the network (originatin void **initialize** **(** :ref:`int` self_peer_id **)** -Initialize the peer with the given ``peer_id`` (must be between 1 and 2147483647). +Initialize the peer with the given ``self_peer_id`` (must be between 1 and 2147483647). Can only be called if the connection status is :ref:`NetworkedMultiplayerPeer.CONNECTION_CONNECTING`. See :ref:`set_connection_status`. diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 96fa5adae..aed8f4c3c 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/enet/doc_classes/NetworkedMultiplayerENet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/enet/doc_classes/NetworkedMultiplayerENet.xml. .. _class_NetworkedMultiplayerENet: diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 03e1a9745..9af01f15d 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NetworkedMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NetworkedMultiplayerPeer.xml. .. _class_NetworkedMultiplayerPeer: @@ -107,7 +107,7 @@ Emitted when a connection attempt succeeds. **peer_connected** **(** :ref:`int` id **)** -Emitted by the server when a client connects. +Emitted when a remote peer connects. .. rst-class:: classref-item-separator @@ -119,7 +119,7 @@ Emitted by the server when a client connects. **peer_disconnected** **(** :ref:`int` id **)** -Emitted by the server when a client disconnects. +Emitted when a remote peer has disconnected. .. rst-class:: classref-item-separator diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 4258f8074..1031f1b1b 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NinePatchRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NinePatchRect.xml. .. _class_NinePatchRect: diff --git a/classes/class_node.rst b/classes/class_node.rst index 80333a408..10fccfe2f 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Node.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Node.xml. .. _class_Node: @@ -177,6 +177,8 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_network_master` **(** **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_node_ready` **(** **)** |const| | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_physics_interpolated` **(** **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_physics_interpolated_and_enabled` **(** **)** |const| | @@ -305,6 +307,18 @@ When this signal is received, the child ``node`` is still in the tree and valid. ---- +.. _class_Node_signal_child_order_changed: + +.. rst-class:: classref-signal + +**child_order_changed** **(** **)** + +Emitted when the list of children is changed. This happens when child nodes are added, moved, or removed. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_signal_ready: .. rst-class:: classref-signal @@ -517,7 +531,7 @@ This notification is emitted *after* the related :ref:`tree_exiting` instead. .. _class_Node_constant_NOTIFICATION_READY: @@ -615,6 +629,14 @@ Use :ref:`Viewport.gui_is_drag_successful` changed. +.. _class_Node_constant_NOTIFICATION_CHILD_ORDER_CHANGED: + +.. rst-class:: classref-constant + +**NOTIFICATION_CHILD_ORDER_CHANGED** = ``24`` + +Notification received when the list of children is changed. This happens when child nodes are added, moved, or removed. + .. _class_Node_constant_NOTIFICATION_INTERNAL_PROCESS: .. rst-class:: classref-constant @@ -773,7 +795,7 @@ Specific to the macOS platform. Notification received from the OS when the app is resumed. -Specific to the Android platform. +Specific to mobile platforms. .. _class_Node_constant_NOTIFICATION_APP_PAUSED: @@ -783,7 +805,9 @@ Specific to the Android platform. Notification received from the OS when the app is paused. -Specific to the Android platform. +Specific to mobile platforms. + +\ **Note:** On iOS, you only have approximately 5 seconds to finish a task started by this signal. If you go over this allotment, iOS will kill the app instead of pausing it. .. rst-class:: classref-section-separator @@ -1621,6 +1645,20 @@ Returns ``true`` if the local system is the master of this node. ---- +.. _class_Node_method_is_node_ready: + +.. rst-class:: classref-method + +:ref:`bool` **is_node_ready** **(** **)** |const| + +Returns ``true`` if the node is ready, i.e. it's inside scene tree and all its children are initialized. + +\ :ref:`request_ready` resets it back to ``false``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_is_physics_interpolated: .. rst-class:: classref-method diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index c8db3fe60..b1f3cef3d 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Node2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Node2D.xml. .. _class_Node2D: diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index c0327b531..447598187 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/NodePath.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/NodePath.xml. .. _class_NodePath: @@ -33,6 +33,7 @@ Some examples of NodePaths include the following: @"." # The current node. @".." # The parent node. @"../C" # A sibling node C. + @"../.." # The grandparent node. # A leading slash means it is absolute from the SceneTree. @"/root" # Equivalent to get_tree().get_root(). @"/root/Main" # If your main scene's root node were named "Main". @@ -191,7 +192,7 @@ For example, ``"Path2D/PathFollow2D/Sprite"`` has 3 names. :ref:`String` **get_subname** **(** :ref:`int` idx **)** -Gets the resource or property name indicated by ``idx`` (0 to :ref:`get_subname_count`). +Gets the resource or property name indicated by ``idx`` (0 to :ref:`get_subname_count` - 1). :: diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index c4e4eb6b4..e1cd6e87a 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/opensimplex/doc_classes/NoiseTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/opensimplex/doc_classes/NoiseTexture.xml. .. _class_NoiseTexture: diff --git a/classes/class_object.rst b/classes/class_object.rst index b1f288f5d..a7c101304 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Object.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Object.xml. .. _class_Object: diff --git a/classes/class_occluder.rst b/classes/class_occluder.rst index 962b913d0..af50615e3 100644 --- a/classes/class_occluder.rst +++ b/classes/class_occluder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Occluder.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Occluder.xml. .. _class_Occluder: diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index d06ef3376..3bb298e17 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OccluderPolygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OccluderPolygon2D.xml. .. _class_OccluderPolygon2D: diff --git a/classes/class_occludershape.rst b/classes/class_occludershape.rst index f35207f78..ca90b19f9 100644 --- a/classes/class_occludershape.rst +++ b/classes/class_occludershape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OccluderShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OccluderShape.xml. .. _class_OccluderShape: diff --git a/classes/class_occludershapepolygon.rst b/classes/class_occludershapepolygon.rst index ee31690b9..6f3edbc68 100644 --- a/classes/class_occludershapepolygon.rst +++ b/classes/class_occludershapepolygon.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OccluderShapePolygon.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OccluderShapePolygon.xml. .. _class_OccluderShapePolygon: diff --git a/classes/class_occludershapesphere.rst b/classes/class_occludershapesphere.rst index 1b8dce2ff..e01707ea6 100644 --- a/classes/class_occludershapesphere.rst +++ b/classes/class_occludershapesphere.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OccluderShapeSphere.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OccluderShapeSphere.xml. .. _class_OccluderShapeSphere: diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 555f41911..b5da695f9 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OmniLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OmniLight.xml. .. _class_OmniLight: diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index ca1869161..1fa5a5d7d 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/opensimplex/doc_classes/OpenSimplexNoise.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/opensimplex/doc_classes/OpenSimplexNoise.xml. .. _class_OpenSimplexNoise: diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index b4b74d89e..176076c89 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OptionButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OptionButton.xml. .. _class_OptionButton: @@ -23,6 +23,8 @@ OptionButton is a type button that provides a selectable list of items when pres See also :ref:`BaseButton` which contains common properties and methods associated with this node. +\ **Note:** The ID values used for items are limited to 32 bits, not full 64 bits of :ref:`int`. This has a range of ``-2^32`` to ``2^32 - 1``, i.e. ``-2147483648`` to ``2147483647``. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_ormspatialmaterial.rst b/classes/class_ormspatialmaterial.rst new file mode 100644 index 000000000..4eebfad4c --- /dev/null +++ b/classes/class_ormspatialmaterial.rst @@ -0,0 +1,27 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ORMSpatialMaterial.xml. + +.. _class_ORMSpatialMaterial: + +ORMSpatialMaterial +================== + +**Inherits:** :ref:`Material3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +ORM 3D rendering material, based on :ref:`Material3D`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This is a variant of the SpatialMaterial that uses an ORM texture to store AO, roughness and metallic information. + +.. |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.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` diff --git a/classes/class_os.rst b/classes/class_os.rst index 071ca97f2..dd7cc46e9 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/OS.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/OS.xml. .. _class_OS: @@ -2334,7 +2334,7 @@ Returns a string that is unique to the device. \ **Note:** This string may change without notice if the user reinstalls/upgrades their operating system or changes their hardware. This means it should generally not be used to encrypt persistent data as the data saved before an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by :ref:`get_unique_id` for security purposes. -\ **Note:** Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet. +\ **Note:** Returns an empty string and prints an error on HTML5, as this method cannot be implemented on this platform. .. rst-class:: classref-item-separator @@ -3276,6 +3276,8 @@ Each :ref:`Dictionary` contains two :ref:`String \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3290,6 +3292,8 @@ Returns an :ref:`PoolStringArray` of voice identifiers fo \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3304,6 +3308,8 @@ Returns ``true`` if the synthesizer is in a paused state. \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3318,6 +3324,8 @@ Returns ``true`` if the synthesizer is generating speech, or have utterance wait \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3332,6 +3340,8 @@ Puts the synthesizer into a paused state. \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3346,6 +3356,8 @@ Resumes the synthesizer if it was paused. \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3366,6 +3378,8 @@ Adds a callback, which is called when the utterance has started, finished, cance \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3394,6 +3408,8 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. rst-class:: classref-item-separator ---- @@ -3408,6 +3424,8 @@ Stops synthesis in progress and removes all utterances from the queue. \ **Note:** This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows. +\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 88dfa13b4..20849a198 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PackedDataContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PackedDataContainer.xml. .. _class_PackedDataContainer: diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index baf645be1..4d7fc10af 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PackedDataContainerRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PackedDataContainerRef.xml. .. _class_PackedDataContainerRef: diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index fc5cdeeda..a8c19eccd 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PackedScene.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PackedScene.xml. .. _class_PackedScene: diff --git a/classes/class_packedscenegltf.rst b/classes/class_packedscenegltf.rst index 517a4fcbd..a4e93849b 100644 --- a/classes/class_packedscenegltf.rst +++ b/classes/class_packedscenegltf.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/PackedSceneGLTF.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gltf/doc_classes/PackedSceneGLTF.xml. .. _class_PackedSceneGLTF: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index d9f42c284..035d73e48 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PacketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PacketPeer.xml. .. _class_PacketPeer: diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index 54a24b09a..9e4128904 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PacketPeerDTLS.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PacketPeerDTLS.xml. .. _class_PacketPeerDTLS: diff --git a/classes/class_packetpeergdnative.rst b/classes/class_packetpeergdnative.rst index eb89bbd90..e762b1e3c 100644 --- a/classes/class_packetpeergdnative.rst +++ b/classes/class_packetpeergdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/PacketPeerGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/PacketPeerGDNative.xml. .. _class_PacketPeerGDNative: diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index d289b430d..d3453268d 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PacketPeerStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PacketPeerStream.xml. .. _class_PacketPeerStream: diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 9e9846c80..63273d878 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PacketPeerUDP.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PacketPeerUDP.xml. .. _class_PacketPeerUDP: diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 00ad9aec2..79e35fc4c 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Panel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Panel.xml. .. _class_Panel: diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index e0ce2bc7c..f9b7d0476 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PanelContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PanelContainer.xml. .. _class_PanelContainer: diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 021419b63..c32a135f8 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PanoramaSky.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PanoramaSky.xml. .. _class_PanoramaSky: diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index b66561fa1..afdba6c6b 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ParallaxBackground.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ParallaxBackground.xml. .. _class_ParallaxBackground: diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index b9a84c681..e186279b1 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ParallaxLayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ParallaxLayer.xml. .. _class_ParallaxLayer: @@ -33,13 +33,15 @@ Properties .. table:: :widths: auto - +-------------------------------+------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`motion_mirroring` | ``Vector2( 0, 0 )`` | - +-------------------------------+------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`motion_offset` | ``Vector2( 0, 0 )`` | - +-------------------------------+------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`motion_scale` | ``Vector2( 1, 1 )`` | - +-------------------------------+------------------------------------------------------------------------+---------------------+ + +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`motion_mirroring` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`motion_offset` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`motion_scale` | ``Vector2( 1, 1 )`` | + +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``1`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator diff --git a/classes/class_particles.rst b/classes/class_particles.rst index c6c41fada..9f04c3a17 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Particles.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Particles.xml. .. _class_Particles: @@ -110,6 +110,25 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_Particles_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +\ **Note:** Due to the particles being computed on the GPU there might be a delay before the signal gets emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 54f324cca..e563101a2 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Particles2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Particles2D.xml. .. _class_Particles2D: @@ -104,6 +104,25 @@ Methods .. rst-class:: classref-descriptions-group +Signals +------- + +.. _class_Particles2D_signal_finished: + +.. rst-class:: classref-signal + +**finished** **(** **)** + +Emitted when all active particles have finished processing. When :ref:`one_shot` is disabled, particles will process continuously, so this is never emitted. + +\ **Note:** Due to the particles being computed on the GPU there might be a delay before the signal gets emitted. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Enumerations ------------ @@ -429,6 +448,8 @@ Method Descriptions Returns a rectangle containing the positions of all existing particles. +\ **Note:** When using threaded rendering this method synchronizes the rendering thread. Calling it often may have a negative impact on performance. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 7ef310c87..66f3d0022 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ParticlesMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ParticlesMaterial.xml. .. _class_ParticlesMaterial: @@ -430,7 +430,7 @@ Property Descriptions Initial rotation applied to each particle, in degrees. -\ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`SpatialMaterial` being used to draw the particle is using :ref:`SpatialMaterial.BILLBOARD_PARTICLES`. +\ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`Material3D` being used to draw the particle is using :ref:`Material3D.BILLBOARD_PARTICLES`. .. rst-class:: classref-item-separator @@ -483,7 +483,7 @@ Rotation randomness ratio. Initial angular velocity applied to each particle in *degrees* per second. Sets the speed of rotation of the particle. -\ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`SpatialMaterial` being used to draw the particle is using :ref:`SpatialMaterial.BILLBOARD_PARTICLES`. +\ **Note:** Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`Material3D` being used to draw the particle is using :ref:`Material3D.BILLBOARD_PARTICLES`. .. rst-class:: classref-item-separator @@ -636,7 +636,9 @@ Animation speed randomness ratio. - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** -Each particle's initial color. If the :ref:`Particles2D`'s ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`SpatialMaterial` make sure to set :ref:`SpatialMaterial.vertex_color_use_as_albedo` to ``true``. +Each particle's initial color. If the :ref:`Particles2D`'s or :ref:`Particles`'s ``texture`` is defined, it will be multiplied by this color. + +\ **Note:** :ref:`color` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color` will have no visible effect. .. rst-class:: classref-item-separator @@ -655,6 +657,8 @@ Each particle's initial color. If the :ref:`Particles2D`'s `` Each particle's initial color will vary along this :ref:`GradientTexture` (multiplied with :ref:`color`). +\ **Note:** :ref:`color_initial_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp` will have no visible effect. + .. rst-class:: classref-item-separator ---- @@ -672,6 +676,8 @@ Each particle's initial color will vary along this :ref:`GradientTexture` over its lifetime (multiplied with :ref:`color`). +\ **Note:** :ref:`color_ramp` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp` will have no visible effect. + .. rst-class:: classref-item-separator ---- @@ -774,6 +780,8 @@ The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX`. +\ **Note:** :ref:`emission_color_texture` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`Material3D`, :ref:`Material3D.vertex_color_use_as_albedo` *must* be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_color_texture` will have no visible effect. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_path.rst b/classes/class_path.rst index 00f0d3ece..edf4b4aa4 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Path.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Path.xml. .. _class_Path: diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 609f8422a..09fceda59 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Path2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Path2D.xml. .. _class_Path2D: diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 6fb680ad0..935e3fe04 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PathFollow.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PathFollow.xml. .. _class_PathFollow: diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index f8a9199b0..9902d41c3 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PathFollow2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PathFollow2D.xml. .. _class_PathFollow2D: diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index ae813a4b1..d28c24e70 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PCKPacker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PCKPacker.xml. .. _class_PCKPacker: diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 66b0b1aca..38b631909 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Performance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Performance.xml. .. _class_Performance: @@ -298,7 +298,7 @@ Number of islands in the 3D physics engine. :ref:`Monitor` **AUDIO_OUTPUT_LATENCY** = ``30`` -Output latency of the :ref:`AudioServer`. +Output latency of the :ref:`AudioServer`. Equivalent to calling :ref:`AudioServer.get_output_latency`, it is not recommended to call this every frame. .. _class_Performance_constant_MONITOR_MAX: diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index 81a556d67..977c825f7 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PHashTranslation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PHashTranslation.xml. .. _class_PHashTranslation: diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 2d545e931..3e06a7265 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicalBone.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicalBone.xml. .. _class_PhysicalBone: @@ -12,9 +12,12 @@ PhysicalBone **Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -.. container:: contribute +.. rst-class:: classref-introduction-group - There is currently no description for this class. Please help us by :ref:`contributing one `! +Description +----------- + +**Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. .. rst-class:: classref-reftable-group diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 338b8f755..d681c94fd 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DDirectBodyState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DDirectBodyState.xml. .. _class_Physics2DDirectBodyState: diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 0b646f8fd..29515190d 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DDirectSpaceState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DDirectSpaceState.xml. .. _class_Physics2DDirectSpaceState: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 7751cc307..923ed5441 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DServer.xml. .. _class_Physics2DServer: diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 8aecc8a39..046600abd 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DShapeQueryParameters.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DShapeQueryParameters.xml. .. _class_Physics2DShapeQueryParameters: diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 5aff77a75..d92a8de8f 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Physics2DTestMotionResult.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Physics2DTestMotionResult.xml. .. _class_Physics2DTestMotionResult: diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 1ae6bb21d..44d92c2b0 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsBody.xml. .. _class_PhysicsBody: @@ -23,6 +23,8 @@ Description PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index e6cc3fb5d..134d45c16 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsBody2D.xml. .. _class_PhysicsBody2D: diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 41a6f87ac..89b795721 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsDirectBodyState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsDirectBodyState.xml. .. _class_PhysicsDirectBodyState: diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 8d9d07991..7e6fb6218 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsDirectSpaceState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsDirectSpaceState.xml. .. _class_PhysicsDirectSpaceState: diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index cbf6cf6ce..8a7c319c5 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsMaterial.xml. .. _class_PhysicsMaterial: diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index db12fd3f7..fca5a69ef 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsServer.xml. .. _class_PhysicsServer: diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index b9d8d0fbd..04fa95348 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsShapeQueryParameters.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsShapeQueryParameters.xml. .. _class_PhysicsShapeQueryParameters: diff --git a/classes/class_physicstestmotionresult.rst b/classes/class_physicstestmotionresult.rst index 13d3b2ec1..8c5aa561d 100644 --- a/classes/class_physicstestmotionresult.rst +++ b/classes/class_physicstestmotionresult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsTestMotionResult.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsTestMotionResult.xml. .. _class_PhysicsTestMotionResult: diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index a83721d9e..f07228f11 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PinJoint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PinJoint.xml. .. _class_PinJoint: diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 79c9f49f9..f1dde1a0c 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PinJoint2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PinJoint2D.xml. .. _class_PinJoint2D: diff --git a/classes/class_plane.rst b/classes/class_plane.rst index b9559313d..f10bb63b0 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Plane.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Plane.xml. .. _class_Plane: diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index e89a0eabd..3477c3ac5 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PlaneMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PlaneMesh.xml. .. _class_PlaneMesh: diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 46c9d6866..101a6fd27 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PlaneShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PlaneShape.xml. .. _class_PlaneShape: diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index 9664c48dc..f4c1c1608 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/PluginScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/PluginScript.xml. .. _class_PluginScript: diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index 0e1a9d787..67c6a55c7 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PointMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PointMesh.xml. .. _class_PointMesh: @@ -21,7 +21,7 @@ Description The PointMesh is made from a single point. Instead of relying on triangles, points are rendered as a single rectangle on the screen with a constant size. They are intended to be used with Particle systems, but can be used as a cheap way to render constant size billboarded sprites (for example in a point cloud). -PointMeshes, must be used with a material that has a point size. Point size can be accessed in a shader with ``POINT_SIZE``, or in a :ref:`SpatialMaterial` by setting :ref:`SpatialMaterial.flags_use_point_size` and the variable :ref:`SpatialMaterial.params_point_size`. +PointMeshes, must be used with a material that has a point size. Point size can be accessed in a shader with ``POINT_SIZE``, or in a :ref:`SpatialMaterial` by setting :ref:`Material3D.flags_use_point_size` and the variable :ref:`Material3D.params_point_size`. When using PointMeshes, properties that normally alter vertices will be ignored, including billboard mode, grow, and cull face. diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index de5ae7d60..8b60adf5c 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Polygon2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Polygon2D.xml. .. _class_Polygon2D: diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 0a234e6fd..f2df1fc22 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PolygonPathFinder.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PolygonPathFinder.xml. .. _class_PolygonPathFinder: diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index f34552b48..afc233206 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolByteArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolByteArray.xml. .. _class_PoolByteArray: diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index f4d31a728..882004538 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolColorArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolColorArray.xml. .. _class_PoolColorArray: diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 3b14dd3be..444a1112d 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolIntArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolIntArray.xml. .. _class_PoolIntArray: diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 927962dd3..645f3c319 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolRealArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolRealArray.xml. .. _class_PoolRealArray: diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 49680f7fd..8fa4a06a9 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolStringArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolStringArray.xml. .. _class_PoolStringArray: diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 1bb4bef9c..fa26f0f2d 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolVector2Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolVector2Array.xml. .. _class_PoolVector2Array: diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 63e6f6ca7..05433e7b7 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PoolVector3Array.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PoolVector3Array.xml. .. _class_PoolVector3Array: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 29512ffa9..ad4f8044a 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Popup.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Popup.xml. .. _class_Popup: diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index 413c2a588..c3b3abe2b 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PopupDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PopupDialog.xml. .. _class_PopupDialog: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 3278dea5a..f12163eb8 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PopupMenu.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PopupMenu.xml. .. _class_PopupMenu: @@ -23,6 +23,8 @@ Description \ **Incremental search:** Like :ref:`ItemList` and :ref:`Tree`, **PopupMenu** supports searching within the list while the control is focused. Press a key that matches the first letter of an item's name to select the first item starting with the given letter. After that point, there are two ways to perform incremental search: 1) Press the same key again before the timeout duration to select the next item starting with the same letter. 2) Press letter keys that match the rest of the word before the timeout duration to match to select the item in question directly. Both of these actions will be reset to the beginning of the list if the timeout duration has passed since the last keystroke was registered. You can adjust the timeout duration by changing :ref:`ProjectSettings.gui/timers/incremental_search_max_interval_msec`. +\ **Note:** The ID values used for items are limited to 32 bits, not full 64 bits of :ref:`int`. This has a range of ``-2^32`` to ``2^32 - 1``, i.e. ``-2147483648`` to ``2147483647``. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index a4c7729af..cf952b7d0 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PopupPanel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PopupPanel.xml. .. _class_PopupPanel: diff --git a/classes/class_portal.rst b/classes/class_portal.rst index 61cd22776..bb6b551a2 100644 --- a/classes/class_portal.rst +++ b/classes/class_portal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Portal.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Portal.xml. .. _class_Portal: @@ -35,6 +35,8 @@ Properties .. table:: :widths: auto + +-------------------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+ + | :ref:`bool` | :ref:`include_in_bound` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+ | :ref:`NodePath` | :ref:`linked_room` | ``NodePath("")`` | +-------------------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+ @@ -70,6 +72,23 @@ Methods Property Descriptions --------------------- +.. _class_Portal_property_include_in_bound: + +.. rst-class:: classref-property + +:ref:`bool` **include_in_bound** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_include_in_bound** **(** :ref:`bool` value **)** +- :ref:`bool` **get_include_in_bound** **(** **)** + +When a manual bound has not been explicitly specified for a :ref:`Room`, the convex hull bound will be estimated from the geometry of the objects within the room. This setting determines whether the portal geometry is included in this estimate of the room bound. + +.. rst-class:: classref-item-separator + +---- + .. _class_Portal_property_linked_room: .. rst-class:: classref-property diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index 44d892076..d6a16fe0d 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Position2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Position2D.xml. .. _class_Position2D: diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 2e821b94d..22dae660b 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Position3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Position3D.xml. .. _class_Position3D: diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 4b8acc392..2694b6a28 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PrimitiveMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PrimitiveMesh.xml. .. _class_PrimitiveMesh: @@ -90,7 +90,7 @@ Overrides the :ref:`AABB` with one defined by user for use with frus If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. -This gives the same result as using :ref:`SpatialMaterial.CULL_BACK` in :ref:`SpatialMaterial.params_cull_mode`. +This gives the same result as using :ref:`Material3D.CULL_BACK` in :ref:`Material3D.params_cull_mode`. .. rst-class:: classref-item-separator diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 1ac77f999..58248fcd5 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PrismMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PrismMesh.xml. .. _class_PrismMesh: diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 1467dc008..ddf092dd1 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProceduralSky.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ProceduralSky.xml. .. _class_ProceduralSky: diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index c43b5c811..e08aa3067 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProgressBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ProgressBar.xml. .. _class_ProgressBar: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 891bf34cd..8628306ff 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProjectSettings.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ProjectSettings.xml. .. _class_ProjectSettings: @@ -46,1017 +46,1037 @@ Properties .. table:: :widths: auto - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`android/modules` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color( 0.14, 0.14, 0.14, 1 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/boot_splash/minimum_display_time` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/description` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/icon` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/name` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/delta_smoothing` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/delta_sync_after_draw` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`application/run/main_scene` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio/2d_panning_strength` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio/3d_panning_strength` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio/channel_disable_threshold_db` | ``-60.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`audio/channel_disable_time` | ``2.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`audio/default_bus_layout` | ``"res://default_bus_layout.tres"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`audio/driver` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio/mix_rate.web` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio/output_latency` | ``15`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio/output_latency.web` | ``50`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`audio/video_delay_compensation_ms` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/export_hint_type_mistmatch` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug to the project developer."`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/settings/physics_interpolation/enable_warnings` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color( 1, 0.2, 0.1, 0.8 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.42 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/disabled_geometry_color` | ``Color( 1, 0.7, 0.1, 0.4 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_color` | ``Color( 0.1, 1, 0.7, 0.4 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2( 0, 0 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2( 10, 10 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`display/window/handheld/orientation` | ``"landscape"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/ios/allow_high_refresh_rate` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/ios/hide_status_bar` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/ios/suppress_ui_gesture` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`display/window/size/height` | ``600`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`display/window/size/test_height` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`display/window/size/test_width` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`display/window/size/width` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`display/window/tablet_driver` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`editor/main_run_args` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`editor/scene_naming` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | ``PoolStringArray( "gd", "gdshader", "shader" )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`editor/version_control_autoload_on_startup` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`editor/version_control_plugin_name` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui/common/drop_mouse_on_gui_input_disabled` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`gui/theme/custom` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui/theme/use_hidpi` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_accept` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_cancel` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_down` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_end` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_focus_next` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_home` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_left` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_page_down` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_page_up` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_right` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_select` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`input/ui_up` | | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_21` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_22` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_23` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_24` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_25` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_26` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_27` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_28` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_29` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_30` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_31` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_32` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_navigation/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_21` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_22` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_23` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_24` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_25` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_26` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_27` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_28` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_29` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_30` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_31` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_32` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_navigation/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`locale/fallback` | ``"en"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`locale/test` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`logging/file_logging/enable_file_logging.pc` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/godot.log"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``5`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`memory/limits/command_queue/multithreading_queue_size_kb` | ``256`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`memory/limits/message_queue/max_size_mb` | ``32`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mono/debugger_agent/port` | ``23685`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | ``3000`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`mono/profiler/args` | ``"log:calls,alloc,sample,output=output.mlpd"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`mono/profiler/enabled` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`mono/runtime/unhandled_exception_policy` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/2d/default_cell_height` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/2d/default_cell_size` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/2d/default_edge_connection_margin` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/3d/default_cell_height` | ``0.25`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`navigation/3d/default_edge_connection_margin` | ``0.25`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`navigation/3d/default_map_up` | ``Vector3( 0, 1, 0 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | ``2048`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_second` | ``100`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | ``10`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/debugger_stdout/max_warnings_per_second` | ``100`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`network/ssl/certificates` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`node/name_casing` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`node/name_num_separator` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/2d/bp_hash_table_size` | ``4096`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/bvh_collision_margin` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/2d/cell_size` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/2d/default_gravity` | ``98`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2( 0, 1 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/2d/large_object_surface_threshold_in_cells` | ``512`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/2d/thread_model` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/2d/use_bvh` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/3d/active_soft_world` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3( 0, -1, 0 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/3d/godot_physics/bvh_collision_margin` | ``0.1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/3d/godot_physics/use_bvh` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/3d/smooth_trimesh_collision` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/common/enable_pause_aware_picking` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`physics/common/physics_interpolation` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/2d/opengl/batching_send_null` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/2d/opengl/batching_stream` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/2d/opengl/legacy_orphan_buffers` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/2d/opengl/legacy_stream` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/2d/options/ninepatch_mode` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/2d/options/use_nvidia_rect_flicker_workaround` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/2d/options/use_software_skinning` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/2d/snapping/use_gpu_pixel_snap` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/debug/diagnose_frame` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/debug/flash_batching` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/batching/lights/max_join_items` | ``32`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/batching/lights/scissor_area_threshold` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/options/single_rect_fallback` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/options/use_batching` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/options/use_batching_in_editor` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/options/use_multirect` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/batching/parameters/batch_buffer_size` | ``16384`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/batching/parameters/colored_vertex_format_threshold` | ``0.25`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/batching/parameters/item_reordering_lookahead` | ``4`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/batching/parameters/max_join_item_commands` | ``16`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/batching/precision/uv_contract` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/batching/precision/uv_contract_amount` | ``100`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/high_quality_ray_count` | ``512`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/low_quality_ray_count` | ``64`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/medium_quality_ray_count` | ``256`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/ultra_quality_ray_count` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float.iOS` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/gles2/compatibility/enable_high_float.Android` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/gles3/shaders/log_active_async_compiles_count` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles` | ``2`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.mobile` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.web` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb` | ``512`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.mobile` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.web` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.mobile` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.web` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | ``4096`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | ``2048`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/rendering/max_lights_per_object` | ``32`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ``65536`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_lights` | ``4096`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_reflections` | ``1024`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/misc/lossless_compression/force_png` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/misc/lossless_compression/webp_compression_level` | ``2`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/misc/mesh_storage/split_stream` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_polygons` | ``8`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_spheres` | ``8`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/advanced/flip_imported_portals` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/debug/logging` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/gameplay/use_signals` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/optimize/remove_danglers` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/pvs/pvs_logging` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/portals/pvs/use_simple_pvs` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/depth/hdr` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/depth/hdr.mobile` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/depth/use_32_bpc_depth` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | ``4096`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | ``2048`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`rendering/quality/driver/driver_name` | ``"GLES3"`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | ``4`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/filters/msaa` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/quality/filters/sharpen_intensity` | ``0.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/filters/use_debanding` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/filters/use_fxaa` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ``2`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ``3`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling.mobile` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/reflections/atlas_size` | ``2048`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/reflections/atlas_subdiv` | ``8`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/reflections/irradiance_max_size` | ``128`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/shading/use_physical_light_attenuation` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/cubemap_size` | ``512`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | ``2`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | ``3`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | ``4`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | ``4096`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | ``2048`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | ``0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/skinning/force_software_skinning` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/skinning/software_skinning_fallback` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/quality/spatial_partitioning/bvh_collision_margin` | ``0.1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`rendering/quality/spatial_partitioning/render_tree_balance` | ``0.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/spatial_partitioning/use_bvh` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | ``1.0`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/threads/thread_model` | ``1`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/threads/thread_safe_bvh` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/viewport/transparent_background` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | ``false`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | ``true`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`world/2d/cell_size` | ``100`` | - +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`android/modules` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color( 0.14, 0.14, 0.14, 1 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/boot_splash/minimum_display_time` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/description` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/icon` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/name` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/delta_smoothing` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/delta_sync_after_draw` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`application/run/main_scene` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio/2d_panning_strength` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio/3d_panning_strength` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio/channel_disable_threshold_db` | ``-60.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`audio/channel_disable_time` | ``2.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`audio/default_bus_layout` | ``"res://default_bus_layout.tres"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`audio/driver` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio/general/ios/mix_with_others` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/general/ios/session_category` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio/general/text_to_speech` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/mix_rate.web` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/output_latency` | ``15`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/output_latency.web` | ``50`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`audio/video_delay_compensation_ms` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/completion/autocomplete_setters_and_getters` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/export_hint_type_mistmatch` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_constant` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/function_conflicts_variable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/function_may_yield` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/integer_division` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unreachable_code` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_argument` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_class_variable` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_signal` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/unused_variable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/variable_conflicts_function` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/gdscript/warnings/void_assignment` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug to the project developer."`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/settings/physics_interpolation/enable_warnings` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/settings/visual_script/max_call_stack` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color( 1, 0.2, 0.1, 0.8 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.42 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/disabled_geometry_color` | ``Color( 1, 0.7, 0.1, 0.4 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_color` | ``Color( 0.1, 1, 0.7, 0.4 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2( 0, 0 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2( 10, 10 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/window/handheld/orientation` | ``"landscape"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/ios/allow_high_refresh_rate` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/ios/hide_status_bar` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/ios/suppress_ui_gesture` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/per_pixel_transparency/enabled` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`display/window/size/height` | ``600`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`display/window/size/test_height` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`display/window/size/test_width` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`display/window/size/width` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`display/window/tablet_driver` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editor/main_run_args` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editor/scene_naming` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | ``PoolStringArray( "gd", "gdshader", "shader" )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editor/version_control_autoload_on_startup` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`editor/version_control_plugin_name` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui/common/drop_mouse_on_gui_input_disabled` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`gui/theme/custom` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui/theme/use_hidpi` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_accept` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_cancel` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_down` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_end` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_focus_next` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_home` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_left` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_page_down` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_page_up` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_right` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_select` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_up` | | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/compatibility/legacy_just_pressed_behavior` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/enable_long_press_as_right_click` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/enable_pan_and_scale_gestures` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`input_devices/pointing/android/rotary_input_scroll_axis` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_21` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_22` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_23` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_24` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_25` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_26` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_27` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_28` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_29` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_30` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_31` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_32` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_navigation/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_21` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_22` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_23` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_24` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_25` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_26` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_27` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_28` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_29` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_30` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_31` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_32` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_navigation/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`locale/fallback` | ``"en"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`locale/test` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`logging/file_logging/enable_file_logging` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`logging/file_logging/enable_file_logging.pc` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/godot.log"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``5`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`memory/limits/command_queue/multithreading_queue_size_kb` | ``256`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`memory/limits/message_queue/max_size_mb` | ``32`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mono/debugger_agent/port` | ``23685`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`mono/debugger_agent/wait_for_debugger` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mono/debugger_agent/wait_timeout` | ``3000`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`mono/profiler/args` | ``"log:calls,alloc,sample,output=output.mlpd"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`mono/profiler/enabled` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`mono/runtime/unhandled_exception_policy` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/2d/default_cell_height` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/2d/default_cell_size` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/2d/default_edge_connection_margin` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/3d/default_cell_height` | ``0.25`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`navigation/3d/default_edge_connection_margin` | ``0.25`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`navigation/3d/default_map_up` | ``Vector3( 0, 1, 0 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/debugger_stdout/max_chars_per_second` | ``2048`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/debugger_stdout/max_errors_per_second` | ``100`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/debugger_stdout/max_messages_per_frame` | ``10`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/debugger_stdout/max_warnings_per_second` | ``100`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_client/max_in_buffer_kb` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_client/max_in_packets` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_client/max_out_buffer_kb` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_client/max_out_packets` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_server/max_in_buffer_kb` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_server/max_in_packets` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_server/max_out_buffer_kb` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/limits/websocket_server/max_out_packets` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`network/ssl/certificates` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`node/name_casing` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`node/name_num_separator` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/2d/bp_hash_table_size` | ``4096`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/bvh_collision_margin` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/2d/cell_size` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/2d/default_gravity` | ``98`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2( 0, 1 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/2d/large_object_surface_threshold_in_cells` | ``512`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/2d/thread_model` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/2d/use_bvh` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/3d/active_soft_world` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3( 0, -1, 0 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/3d/godot_physics/bvh_collision_margin` | ``0.1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/3d/godot_physics/use_bvh` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/3d/smooth_trimesh_collision` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/common/enable_pause_aware_picking` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics/common/physics_interpolation` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/opengl/batching_send_null` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/opengl/batching_stream` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/opengl/legacy_orphan_buffers` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/opengl/legacy_stream` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/options/culling_mode` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/2d/options/ninepatch_mode` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/2d/options/use_nvidia_rect_flicker_workaround` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/2d/options/use_software_skinning` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/2d/snapping/use_gpu_pixel_snap` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/debug/diagnose_frame` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/debug/flash_batching` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/batching/lights/max_join_items` | ``32`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/batching/lights/scissor_area_threshold` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/options/single_rect_fallback` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/options/use_batching` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/options/use_batching_in_editor` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/options/use_multirect` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/batching/parameters/batch_buffer_size` | ``16384`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/batching/parameters/colored_vertex_format_threshold` | ``0.25`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/batching/parameters/item_reordering_lookahead` | ``4`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/batching/parameters/max_join_item_commands` | ``16`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/batching/precision/uv_contract` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/batching/precision/uv_contract_amount` | ``100`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/high_quality_ray_count` | ``512`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/low_quality_ray_count` | ``64`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/medium_quality_ray_count` | ``256`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/cpu_lightmapper/quality/ultra_quality_ray_count` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/gles2/compatibility/disable_half_float.iOS` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/gles2/compatibility/enable_high_float.Android` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/gles3/shaders/log_active_async_compiles_count` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles` | ``2`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.mobile` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/max_simultaneous_compiles.web` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb` | ``512`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.mobile` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_cache_size_mb.web` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.mobile` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/gles3/shaders/shader_compilation_mode.web` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/buffers/blend_shape_max_buffer_size_kb` | ``4096`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_buffer_size_kb` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/buffers/canvas_polygon_index_buffer_size_kb` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/buffers/immediate_buffer_size_kb` | ``2048`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/rendering/max_lights_per_object` | ``32`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ``65536`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_lights` | ``4096`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_reflections` | ``1024`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/misc/lossless_compression/force_png` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/misc/lossless_compression/webp_compression_level` | ``2`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/misc/mesh_storage/split_stream` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_polygons` | ``8`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/misc/occlusion_culling/max_active_spheres` | ``8`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/advanced/flip_imported_portals` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/debug/logging` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/gameplay/use_signals` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/optimize/remove_danglers` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/pvs/pvs_logging` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/portals/pvs/use_simple_pvs` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/depth/hdr` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/depth/hdr.mobile` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/depth/use_32_bpc_depth` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rendering/quality/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/depth_prepass/enable` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/directional_shadow/size` | ``4096`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/directional_shadow/size.mobile` | ``2048`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`rendering/quality/driver/driver_name` | ``"GLES3"`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/driver/fallback_to_gles2` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/filters/anisotropic_filter_level` | ``4`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/filters/msaa` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/quality/filters/sharpen_intensity` | ``0.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/filters/use_debanding` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/filters/use_fxaa` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ``2`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ``3`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/lightmapping/use_bicubic_sampling.mobile` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/reflections/atlas_size` | ``2048`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/reflections/atlas_subdiv` | ``8`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/reflections/high_quality_ggx.mobile` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/reflections/irradiance_max_size` | ``128`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/reflections/texture_array_reflections.mobile` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_blinn_over_ggx.mobile` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_lambert_over_burley.mobile` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/force_vertex_shading.mobile` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shading/use_physical_light_attenuation` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/cubemap_size` | ``512`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_0_subdiv` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_1_subdiv` | ``2`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_2_subdiv` | ``3`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/quadrant_3_subdiv` | ``4`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/size` | ``4096`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadow_atlas/size.mobile` | ``2048`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shadows/caster_culling` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadows/filter_mode` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/shadows/filter_mode.mobile` | ``0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/shadows/light_culling` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/skinning/force_software_skinning` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/skinning/software_skinning_fallback` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/quality/spatial_partitioning/bvh_collision_margin` | ``0.1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`rendering/quality/spatial_partitioning/render_tree_balance` | ``0.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/spatial_partitioning/use_bvh` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/follow_surface` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/subsurface_scattering/quality` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/quality/subsurface_scattering/scale` | ``1.0`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/subsurface_scattering/weight_samples` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/quality/voxel_cone_tracing/high_quality` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/threads/thread_model` | ``1`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/threads/thread_safe_bvh` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/viewport/transparent_background` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/vram_compression/import_bptc` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/vram_compression/import_etc` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/vram_compression/import_etc2` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/vram_compression/import_pvrtc` | ``false`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`rendering/vram_compression/import_s3tc` | ``true`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`world/2d/cell_size` | ``100`` | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -1554,6 +1574,46 @@ If ``true``, microphone input will be allowed. This requires appropriate permiss ---- +.. _class_ProjectSettings_property_audio/general/ios/mix_with_others: + +.. rst-class:: classref-property + +:ref:`bool` **audio/general/ios/mix_with_others** = ``false`` + +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``. + +\ ``Ambient`` always has this set per default. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_audio/general/ios/session_category: + +.. rst-class:: classref-property + +:ref:`int` **audio/general/ios/session_category** = ``0`` + +Sets the `AVAudioSessionCategory `__ on iOS. Use the ``Playback`` category to get sound output, even if the phone is in silent mode. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_audio/general/text_to_speech: + +.. rst-class:: classref-property + +:ref:`bool` **audio/general/text_to_speech** = ``false`` + +If ``true``, text-to-speech support is enabled, see :ref:`OS.tts_get_voices` and :ref:`OS.tts_speak`. + +\ **Note:** Enabling TTS can cause addition idle CPU usage and interfere with the sleep mode, so consider disabling it if TTS is not used. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_audio/mix_rate: .. rst-class:: classref-property @@ -1850,7 +1910,7 @@ If ``true``, enables warnings when using a property as if it was a function. .. rst-class:: classref-property -:ref:`bool` **debug/gdscript/warnings/return_value_discarded** = ``true`` +:ref:`bool` **debug/gdscript/warnings/return_value_discarded** = ``false`` If ``true``, enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the :ref:`Error` enum. @@ -2968,6 +3028,58 @@ Enabling this can greatly improve the responsiveness to input, specially in devi ---- +.. _class_ProjectSettings_property_input_devices/compatibility/legacy_just_pressed_behavior: + +.. rst-class:: classref-property + +:ref:`bool` **input_devices/compatibility/legacy_just_pressed_behavior** = ``false`` + +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. + +If ``false``, no input will be lost. + +\ **Note:** You should in nearly all cases prefer the ``false`` setting. The legacy behavior is to enable supporting old projects that rely on the old logic, without changes to script. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input_devices/pointing/android/enable_long_press_as_right_click: + +.. rst-class:: classref-property + +:ref:`bool` **input_devices/pointing/android/enable_long_press_as_right_click** = ``false`` + +If ``true``, long press events on an Android touchscreen are transformed into right click events. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input_devices/pointing/android/enable_pan_and_scale_gestures: + +.. rst-class:: classref-property + +:ref:`bool` **input_devices/pointing/android/enable_pan_and_scale_gestures** = ``false`` + +If ``true``, multi-touch pan and scale gestures are enabled on Android devices. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input_devices/pointing/android/rotary_input_scroll_axis: + +.. rst-class:: classref-property + +:ref:`int` **input_devices/pointing/android/rotary_input_scroll_axis** = ``1`` + +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. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: .. rst-class:: classref-property @@ -5294,7 +5406,7 @@ Default map up vector for 3D navigation maps. See :ref:`NavigationServer.map_set :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** = ``2048`` -Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped with the message ``"output overflow, print less text!"``. This helps not to stall the debugger connection. .. rst-class:: classref-item-separator @@ -5998,6 +6110,20 @@ Controls how much physics ticks are synchronized with real time. For 0 or less, ---- +.. _class_ProjectSettings_property_rendering/2d/options/culling_mode: + +.. rst-class:: classref-property + +:ref:`int` **rendering/2d/options/culling_mode** = ``1`` + +The culling mode determines the method used for rejecting canvas items that are outside a viewport. The visual result should be identical, but some modes may be faster for a particular project. + +You can either cull items individually (``Item mode``), or use hierarchical culling (``Node mode``) which has a little more housekeeping but can increase performance by culling large numbers of items at once. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/2d/options/ninepatch_mode: .. rst-class:: classref-property @@ -6466,12 +6592,14 @@ If set to ``Asynchronous`` and available on the target device, asynchronous comp That means that when a shader is first used under some new rendering situation, the game won't stall while such shader is being compiled. Instead, a fallback will be used and the real shader will be compiled in the background. Once the actual shader is compiled, it will be used the next times it's used to draw a frame. -Depending on the async mode configured for a given material/shader, the fallback will be an "ubershader" (the default) or just skip rendering any item it is applied to. +Depending on the :ref:`Material3D.async_mode` mode configured for a given material, the fallback will be an "ubershader" (the default) or just skip rendering any item it is applied to. In custom :ref:`ShaderMaterial`\ s, the async mode is set using ``render_mode async_visible;`` (default) or ``render_mode async_hidden;`` at the top of the shader. An ubershader is a very complex shader, slow but suited to any rendering situation, that the engine generates internally so it can be used from the beginning while the traditional conditioned, optimized version of it is being compiled. To reduce loading times after the project has been launched at least once, you can use ``Asynchronous + Cache``. This also causes the ubershaders to be cached into storage so they can be ready faster next time they are used (provided the platform provides support for it). +\ **Note:** Asynchronous compilation requires driver support for the ``GL_ARB_get_program_binary`` OpenGL extension. This extension is supported by all hardware that supports OpenGL 4.1 or higher as well as most hardware that supports OpenGL 3.3 or higher. + \ **Note:** Asynchronous compilation is currently only supported for spatial (3D) and particle materials/shaders. CanvasItem (2D) shaders will not use asynchronous compilation even if this setting is set to ``Asynchronous`` or ``Asynchronous + Cache``. .. rst-class:: classref-item-separator @@ -7158,9 +7286,9 @@ Lower-end override for :ref:`rendering/quality/shading/force_lambert_over_burley :ref:`bool` **rendering/quality/shading/force_vertex_shading** = ``false`` -If ``true``, forces vertex shading for all 3D :ref:`SpatialMaterial` and :ref:`ShaderMaterial` rendering. This can be used to improve performance on low-end mobile devices. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled. +If ``true``, forces vertex shading for all 3D :ref:`Material3D` and :ref:`ShaderMaterial` rendering. This can be used to improve performance on low-end mobile devices. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled. -See also :ref:`SpatialMaterial.flags_vertex_lighting` which can be used to enable vertex shading on specific materials only. +See also :ref:`Material3D.flags_vertex_lighting` which can be used to enable vertex shading on specific materials only. \ **Note:** This setting does not affect unshaded materials. @@ -7278,6 +7406,22 @@ Lower-end override for :ref:`rendering/quality/shadow_atlas/size` **rendering/quality/shadows/caster_culling** = ``true`` + +If ``true``, items that cannot cast shadows into the view frustum will not be rendered into shadow maps. + +This can increase performance. + +\ **Note:** This setting only takes effect when :ref:`rendering/quality/shadows/light_culling` is also ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/quality/shadows/filter_mode: .. rst-class:: classref-property @@ -7304,6 +7448,20 @@ Lower-end override for :ref:`rendering/quality/shadows/filter_mode` **rendering/quality/shadows/light_culling** = ``true`` + +If ``true``, prevents shadows from rendering for lights that do not intersect the view frustum. + +This can increase performance. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/quality/skinning/force_software_skinning: .. rst-class:: classref-property diff --git a/classes/class_propertytweener.rst b/classes/class_propertytweener.rst index c4663a1a3..35e7ed131 100644 --- a/classes/class_propertytweener.rst +++ b/classes/class_propertytweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PropertyTweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PropertyTweener.xml. .. _class_PropertyTweener: diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 42642a595..6261c15c4 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProximityGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ProximityGroup.xml. .. _class_ProximityGroup: diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 63a533a1d..831660ba8 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProxyTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ProxyTexture.xml. .. _class_ProxyTexture: diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index 2338427f8..71a2f0a33 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/QuadMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/QuadMesh.xml. .. _class_QuadMesh: diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 58567249b..110a49740 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Quat.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Quat.xml. .. _class_Quat: diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index 69fb93948..a67c4726e 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RandomNumberGenerator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RandomNumberGenerator.xml. .. _class_RandomNumberGenerator: diff --git a/classes/class_range.rst b/classes/class_range.rst index 18d327a54..345cf5153 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Range.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Range.xml. .. _class_Range: diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 716823fcd..7c8c66ded 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RayCast.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RayCast.xml. .. _class_RayCast: diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 967877222..0877d4123 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RayCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RayCast2D.xml. .. _class_RayCast2D: diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index c56e61168..5bc11eb0e 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RayShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RayShape.xml. .. _class_RayShape: diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 4f182cc06..8bf530d41 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RayShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RayShape2D.xml. .. _class_RayShape2D: diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 18b53c750..a3b6383d3 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Rect2.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Rect2.xml. .. _class_Rect2: diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index a4716be9c..7dbe57a46 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RectangleShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RectangleShape2D.xml. .. _class_RectangleShape2D: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index bf9b69ae2..d753acfd0 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Reference.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Reference.xml. .. _class_Reference: diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 8d2207941..29fa8f018 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ReferenceRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ReferenceRect.xml. .. _class_ReferenceRect: diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index f4caf0452..b762a360a 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ReflectionProbe.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ReflectionProbe.xml. .. _class_ReflectionProbe: diff --git a/classes/class_regex.rst b/classes/class_regex.rst index edacf06aa..089d768b8 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/regex/doc_classes/RegEx.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/regex/doc_classes/RegEx.xml. .. _class_RegEx: diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 960491bce..0b86eedc2 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/regex/doc_classes/RegExMatch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/regex/doc_classes/RegExMatch.xml. .. _class_RegExMatch: diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 949bf648d..75acc46d3 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RemoteTransform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RemoteTransform.xml. .. _class_RemoteTransform: diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 945abdb9b..f2a52f44b 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RemoteTransform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RemoteTransform2D.xml. .. _class_RemoteTransform2D: diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 654c2afba..a81caea81 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Resource.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Resource.xml. .. _class_Resource: @@ -12,16 +12,20 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BakedLightmapData`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CryptoKey`, :ref:`CubeMap`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`EditorSpatialGizmoPlugin`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :ref:`OccluderShape`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RichTextEffect`, :ref:`Script`, :ref:`Shader`, :ref:`Shape`, :ref:`Shape2D`, :ref:`ShortCut`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`TextFile`, :ref:`Texture`, :ref:`TextureLayered`, :ref:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BakedLightmapData`, :ref:`BitMap`, :ref:`ButtonGroup`, :ref:`CryptoKey`, :ref:`CubeMap`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`EditorSpatialGizmoPlugin`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFCollider`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :ref:`OccluderShape`, :ref:`OpenSimplexNoise`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RichTextEffect`, :ref:`Script`, :ref:`Shader`, :ref:`Shape`, :ref:`Shape2D`, :ref:`ShortCut`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`TextFile`, :ref:`Texture`, :ref:`TextureLayered`, :ref:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D`, :ref:`X509Certificate` -Base class for all resources. +Base class for serializable objects. .. rst-class:: classref-introduction-group Description ----------- -Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Since they inherit from :ref:`Reference`, resources are reference-counted and freed when no longer in use. They are also cached once loaded from disk, so that any further attempts to load a resource from a given path will return the same reference (all this in contrast to a :ref:`Node`, which is not reference-counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node` or another resource. +Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Since they inherit from :ref:`Reference`, resources are reference-counted and freed when no longer in use. They can also be nested within other resources, and saved on disk. :ref:`PackedScene`, one of the most common :ref:`Object`\ s in a Godot project, is also a resource, uniquely capable of storing and instantiating the :ref:`Node`\ s it contains as many times as desired. + +In GDScript, resources can loaded from disk by their :ref:`resource_path` using :ref:`@GDScript.load` or :ref:`@GDScript.preload`. + +The engine keeps a global cache of all loaded resources, referenced by paths (see :ref:`ResourceLoader.has_cached`). A resource will be cached when loaded for the first time and removed from cache once all references are released. When a resource is cached, subsequent loads using its path will return the cached reference. \ **Note:** In C#, resources will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free resources that are no longer in use. This means that unused resources will linger on for a while before being removed. @@ -89,7 +93,7 @@ Signals **changed** **(** **)** -Emitted whenever the resource changes. +Emitted when the resource changes, usually when one of its properties is modified. See also :ref:`emit_changed`. \ **Note:** This signal is not emitted automatically for custom resources, which means that you need to create a setter and emit the signal yourself. @@ -113,7 +117,9 @@ Property Descriptions - void **set_local_to_scene** **(** :ref:`bool` value **)** - :ref:`bool` **is_local_to_scene** **(** **)** -If ``true``, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene. +If ``true``, the resource is duplicated for each instance of all scenes using it. At run-time, the resource can be modified in one scene without affecting other instances (see :ref:`PackedScene.instance`). + +\ **Note:** Changing this property at run-time has no effect on already created duplicate resources. .. rst-class:: classref-item-separator @@ -130,7 +136,9 @@ If ``true``, the resource will be made unique in each instance of its local scen - void **set_name** **(** :ref:`String` value **)** - :ref:`String` **get_name** **(** **)** -The name of the resource. This is an optional identifier. If :ref:`resource_name` is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the :ref:`resource_name` will be displayed as the tab name in the script editor. +An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor. + +\ **Note:** Some resource formats do not support resource names. You can still set the name in the editor or via code, but it will be lost when the resource is reloaded. For example, only built-in scripts can have a resource name, while scripts stored in separate files cannot. .. rst-class:: classref-item-separator @@ -147,7 +155,9 @@ The name of the resource. This is an optional identifier. If :ref:`resource_name - void **set_path** **(** :ref:`String` value **)** - :ref:`String` **get_path** **(** **)** -The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index. +The unique path to this resource. If it has been saved to disk, the value will be its filepath. If the resource is exclusively contained within a scene, the value will be the :ref:`PackedScene`'s filepath, followed by a unique identifier. + +\ **Note:** Setting this property manually may fail if a resource with the same path has already been previously loaded. If necessary, use :ref:`take_over_path`. .. rst-class:: classref-section-separator @@ -164,7 +174,18 @@ Method Descriptions void **_setup_local_to_scene** **(** **)** |virtual| -Virtual function which can be overridden to customize the behavior value of :ref:`setup_local_to_scene`. +Override this method to customize the newly duplicated resource created from :ref:`PackedScene.instance`, if the original's :ref:`resource_local_to_scene` is set to ``true``. + +\ **Example:** Set a random ``damage`` value to every local resource from an instantiated scene. + +:: + + extends Resource + + var damage = 0 + + func _setup_local_to_scene(): + damage = rand_range(10, 40) .. rst-class:: classref-item-separator @@ -176,13 +197,11 @@ Virtual function which can be overridden to customize the behavior value of :ref :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** |const| -Duplicates the resource, returning a new resource with the exported members copied. **Note:** To duplicate the resource the constructor is called without arguments. This method will error when the constructor doesn't have default values. +Duplicates this resource, returning a new resource with its ``export``\ ed or :ref:`@GlobalScope.PROPERTY_USAGE_STORAGE` properties copied from the original. -By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing ``true`` to the ``subresources`` argument which will copy the subresources. +If ``subresources`` is ``false``, a shallow copy is returned; nested resources within subresources are not duplicated and are shared from the original resource. If ``subresources`` is ``true``, a deep copy is returned; nested subresources will be duplicated and are not shared. -\ **Note:** If ``subresources`` is ``true``, this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared. - -\ **Note:** When duplicating a resource, only ``export``\ ed properties are copied. Other properties will be set to their default value in the new resource. +\ **Note:** For custom resources, this method will fail if :ref:`Object._init` has been defined with required parameters. .. rst-class:: classref-item-separator @@ -194,17 +213,18 @@ By default, sub-resources are shared between resource copies for efficiency. Thi void **emit_changed** **(** **)** -Emits the :ref:`changed` signal. +Emits the :ref:`changed` signal. This method is called automatically for some built-in resources. -If external objects which depend on this resource should be updated, this method must be called manually whenever the state of this resource has changed (such as modification of properties). - -The method is equivalent to: +\ **Note:** For custom resources, it's recommended to call this method whenever a meaningful change occurs, such as a modified property. This ensures that custom :ref:`Object`\ s depending on the resource are properly updated. :: - emit_signal("changed") - -\ **Note:** This method is called automatically for built-in resources. + var damage setget set_damage + + func set_damage(new_value): + if damage != new_value: + damage = new_value + emit_changed() .. rst-class:: classref-item-separator @@ -216,7 +236,7 @@ The method is equivalent to: :ref:`Node` **get_local_scene** **(** **)** |const| -If :ref:`resource_local_to_scene` is enabled and the resource was loaded from a :ref:`PackedScene` instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns ``null``. +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``. .. rst-class:: classref-item-separator @@ -228,7 +248,7 @@ If :ref:`resource_local_to_scene` **get_rid** **(** **)** |const| -Returns the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high-level abstractions of resources stored in a server, so this function will return the original RID. +Returns the :ref:`RID` of this resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Shape`, and so on) are high-level abstractions of resources stored in a specialized server (:ref:`VisualServer`, :ref:`PhysicsServer`, etc.), so this function will return the original :ref:`RID`. .. rst-class:: classref-item-separator @@ -240,9 +260,7 @@ Returns the RID of the resource (or an empty RID). Many resources (such as :ref: void **setup_local_to_scene** **(** **)** -This method is called when a resource with :ref:`resource_local_to_scene` enabled is loaded from a :ref:`PackedScene` instantiation. Its behavior can be customized by overriding :ref:`_setup_local_to_scene` from script. - -For most resources, this method performs no base logic. :ref:`ViewportTexture` performs custom logic to properly set the proxy texture and flags in the local viewport. +Calls :ref:`_setup_local_to_scene`. If :ref:`resource_local_to_scene` is set to ``true``, this method is automatically called from :ref:`PackedScene.instance` by the newly duplicated resource within the scene instance. .. rst-class:: classref-item-separator @@ -254,7 +272,7 @@ For most resources, this method performs no base logic. :ref:`ViewportTexture` path **)** -Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting :ref:`resource_path`, as the latter would error out if another resource was already cached for the given path. +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. .. |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_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 83812ce7c..1e29fe417 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceFormatLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceFormatLoader.xml. .. _class_ResourceFormatLoader: diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index 63ee760f2..b90b18593 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceFormatSaver.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceFormatSaver.xml. .. _class_ResourceFormatSaver: diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 70f6215e1..63e0b2641 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceImporter.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceImporter.xml. .. _class_ResourceImporter: diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index f5ba93738..8b6ee9774 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceInteractiveLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceInteractiveLoader.xml. .. _class_ResourceInteractiveLoader: diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 17445f671..2289e24a0 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceLoader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceLoader.xml. .. _class_ResourceLoader: diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 2761d49b1..e5a74e1b2 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourcePreloader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourcePreloader.xml. .. _class_ResourcePreloader: diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 6ec5917dd..475f8c4c5 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceSaver.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceSaver.xml. .. _class_ResourceSaver: diff --git a/classes/class_richtexteffect.rst b/classes/class_richtexteffect.rst index d9dc70028..ab44a8809 100644 --- a/classes/class_richtexteffect.rst +++ b/classes/class_richtexteffect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RichTextEffect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RichTextEffect.xml. .. _class_RichTextEffect: diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index c8288e124..d85e6c00c 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RichTextLabel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RichTextLabel.xml. .. _class_RichTextLabel: diff --git a/classes/class_rid.rst b/classes/class_rid.rst index c8826f710..3d0592b92 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RID.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RID.xml. .. _class_RID: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index f80057d22..efebaf345 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RigidBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RigidBody.xml. .. _class_RigidBody: @@ -31,6 +31,8 @@ If you need to override the default physics behavior, you can write a custom for With Bullet physics (the default), the center of mass is the RigidBody3D center. With GodotPhysics, the center of mass is the average of the :ref:`CollisionShape` centers. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-introduction-group Tutorials @@ -181,9 +183,19 @@ Emitted when one of this RigidBody's :ref:`Shape`\ s collides with \ ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``body_shape_index`` the index of the :ref:`Shape` of the other :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape` of the other :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``local_shape_index`` the index of the :ref:`Shape` of this RigidBody used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` of this RigidBody. + +\ **Example of getting the** :ref:`CollisionShape` **node from the shape index:**\ + +:: + + var body_shape_owner = body.shape_find_owner(body_shape_index) + var body_shape_node = body.shape_owner_get_owner(body_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) \ **Note:** Bullet physics cannot identify the shape index when using a :ref:`ConcavePolygonShape`. Don't use multiple :ref:`CollisionShape`\ s when using a :ref:`ConcavePolygonShape` with Bullet physics if you need shape indices. @@ -203,12 +215,14 @@ Emitted when the collision between one of this RigidBody's :ref:`Shape`, if it exists in the tree, of the other :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``body_shape_index`` the index of the :ref:`Shape` of the other :ref:`PhysicsBody` or :ref:`GridMap` used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape` of the other :ref:`PhysicsBody` or :ref:`GridMap`. -\ ``local_shape_index`` the index of the :ref:`Shape` of this RigidBody used by the :ref:`PhysicsServer`. Get the :ref:`CollisionShape` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape` of this RigidBody. \ **Note:** Bullet physics cannot identify the shape index when using a :ref:`ConcavePolygonShape`. Don't use multiple :ref:`CollisionShape`\ s when using a :ref:`ConcavePolygonShape` with Bullet physics if you need shape indices. +See also :ref:`body_shape_entered`. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index c7e2262f2..6b53a7489 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RigidBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RigidBody2D.xml. .. _class_RigidBody2D: @@ -169,9 +169,19 @@ Emitted when one of this RigidBody2D's :ref:`Shape2D`\ s collides \ ``body`` the :ref:`Node`, if it exists in the tree, of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this RigidBody2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` of this RigidBody2D. + +\ **Example of getting the** :ref:`CollisionShape2D` **node from the shape index:**\ + +:: + + var body_shape_owner = body.shape_find_owner(body_shape_index) + var body_shape_node = body.shape_owner_get_owner(body_shape_owner) + + var local_shape_owner = shape_find_owner(local_shape_index) + var local_shape_node = shape_owner_get_owner(local_shape_owner) .. rst-class:: classref-item-separator @@ -189,9 +199,11 @@ Emitted when the collision between one of this RigidBody2D's :ref:`Shape2D`, if it exists in the tree, of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap` used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``body.shape_owner_get_owner(body_shape_index)``. +\ ``body_shape_index`` the index of the :ref:`Shape2D` of the other :ref:`PhysicsBody2D` or :ref:`TileMap`. -\ ``local_shape_index`` the index of the :ref:`Shape2D` of this RigidBody2D used by the :ref:`Physics2DServer`. Get the :ref:`CollisionShape2D` node with ``self.shape_owner_get_owner(local_shape_index)``. +\ ``local_shape_index`` the index of the :ref:`Shape2D` of this RigidBody2D. + +See also :ref:`body_shape_entered`. .. rst-class:: classref-item-separator diff --git a/classes/class_room.rst b/classes/class_room.rst index abf0c8a3d..5f52d876b 100644 --- a/classes/class_room.rst +++ b/classes/class_room.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Room.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Room.xml. .. _class_Room: diff --git a/classes/class_roomgroup.rst b/classes/class_roomgroup.rst index ec764da6e..91e81753e 100644 --- a/classes/class_roomgroup.rst +++ b/classes/class_roomgroup.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RoomGroup.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RoomGroup.xml. .. _class_RoomGroup: diff --git a/classes/class_roommanager.rst b/classes/class_roommanager.rst index e052d7e87..7ee2193b6 100644 --- a/classes/class_roommanager.rst +++ b/classes/class_roommanager.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RoomManager.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RoomManager.xml. .. _class_RoomManager: diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 1b0f456c3..a8ac142bf 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/RootMotionView.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RootMotionView.xml. .. _class_RootMotionView: diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index e8cadeb25..7ed429d08 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SceneState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SceneState.xml. .. _class_SceneState: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 478c86ecc..cadabe4ac 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SceneTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SceneTree.xml. .. _class_SceneTree: @@ -93,6 +93,8 @@ Methods +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SceneTreeTween` | :ref:`create_tween` **(** **)** | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`get_first_node_in_group` **(** :ref:`String` group **)** | + +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** |const| | +---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** |const| | @@ -829,6 +831,18 @@ Creates and returns a new :ref:`SceneTreeTween`. ---- +.. _class_SceneTree_method_get_first_node_in_group: + +.. rst-class:: classref-method + +:ref:`Node` **get_first_node_in_group** **(** :ref:`String` group **)** + +Returns the first node in the specified group, or ``null`` if the group is empty or does not exist. + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneTree_method_get_frame: .. rst-class:: classref-method diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 07b5dd871..006605185 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SceneTreeTimer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SceneTreeTimer.xml. .. _class_SceneTreeTimer: diff --git a/classes/class_scenetreetween.rst b/classes/class_scenetreetween.rst index ec94025cc..2ad3e9b0c 100644 --- a/classes/class_scenetreetween.rst +++ b/classes/class_scenetreetween.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SceneTreeTween.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SceneTreeTween.xml. .. _class_SceneTreeTween: @@ -76,7 +76,7 @@ You should avoid using more than one **SceneTreeTween** per object's property. I Some :ref:`Tweener`\ s use transitions and eases. The first accepts a :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see `easings.net `__ for some examples). The second accepts an :ref:`EaseType` constant, and controls where the ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with :ref:`Tween.EASE_IN_OUT`, and use the one that looks best. -\ `Tween easing and transition types cheatsheet `__\ +\ `Tween easing and transition types cheatsheet `__\ \ **Note:** All **SceneTreeTween**\ s will automatically start by default. To prevent a **SceneTreeTween** from autostarting, you can call :ref:`stop` immediately after it is created. diff --git a/classes/class_script.rst b/classes/class_script.rst index 4f4495090..f9e2b6e09 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Script.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Script.xml. .. _class_Script: diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index d63773997..234a3196e 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ScriptCreateDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ScriptCreateDialog.xml. .. _class_ScriptCreateDialog: diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 08388536a..f8da34118 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ScriptEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ScriptEditor.xml. .. _class_ScriptEditor: @@ -34,6 +34,8 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_base_editor` **(** **)** |const| | + +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Script` | :ref:`get_current_script` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` point, :ref:`Control` from **)** | @@ -113,6 +115,18 @@ void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` **get_base_editor** **(** **)** |const| + +Returns the underlying :ref:`Control` used for editing scripts. For text scripts, this is a :ref:`TextEdit`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptEditor_method_get_current_script: .. rst-class:: classref-method diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 8b629ce84..01d35c4fe 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ScrollBar.xml. .. _class_ScrollBar: diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 49e9128b8..b46836601 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ScrollContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ScrollContainer.xml. .. _class_ScrollContainer: @@ -169,6 +169,13 @@ If ``true``, the ScrollContainer will automatically scroll to focused children ( The current horizontal scroll value. +\ **Note:** If you are setting this value in the :ref:`Node._ready` function or earlier, it needs to be wrapped with :ref:`Object.set_deferred`, since scroll bar's :ref:`Range.max_value` is not initialized yet. + +:: + + func _ready(): + set_deferred("scroll_horizontal", 600) + .. rst-class:: classref-item-separator ---- @@ -203,6 +210,13 @@ If ``true``, enables horizontal scrolling. The current vertical scroll value. +\ **Note:** Setting it early needs to be deferred, just like in :ref:`scroll_horizontal`. + +:: + + func _ready(): + set_deferred("scroll_vertical", 600) + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index a4c676663..f7aeb38fb 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SegmentShape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SegmentShape2D.xml. .. _class_SegmentShape2D: diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index f957efeac..6be3a44b8 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Semaphore.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Semaphore.xml. .. _class_Semaphore: @@ -21,6 +21,14 @@ Description A synchronization semaphore which can be used to synchronize multiple :ref:`Thread`\ s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see :ref:`Mutex`. +\ **Warning:**\ + +To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met: + +- By the time a **Semaphore**'s reference count reaches zero and therefore it is destroyed, no threads must be waiting on it. + +- By the time a :ref:`Thread`'s reference count reaches zero and therefore it is destroyed, it must not be waiting on any semaphore. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_separator.rst b/classes/class_separator.rst index d45858696..53790ff38 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Separator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Separator.xml. .. _class_Separator: diff --git a/classes/class_shader.rst b/classes/class_shader.rst index ef448be7e..ad40463cc 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Shader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Shader.xml. .. _class_Shader: diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 9414f9e32..9c9a70888 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ShaderMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ShaderMaterial.xml. .. _class_ShaderMaterial: diff --git a/classes/class_shape.rst b/classes/class_shape.rst index f6023a377..76b86ab31 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Shape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Shape.xml. .. _class_Shape: diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index cf5e28e92..76b30ed95 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Shape2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Shape2D.xml. .. _class_Shape2D: diff --git a/classes/class_shapecast.rst b/classes/class_shapecast.rst index 823bdc943..4794000d8 100644 --- a/classes/class_shapecast.rst +++ b/classes/class_shapecast.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ShapeCast.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ShapeCast.xml. .. _class_ShapeCast: diff --git a/classes/class_shapecast2d.rst b/classes/class_shapecast2d.rst index a8a471ba7..c4ad97f34 100644 --- a/classes/class_shapecast2d.rst +++ b/classes/class_shapecast2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ShapeCast2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ShapeCast2D.xml. .. _class_ShapeCast2D: diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 839f28ab4..6e19c96f9 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ShortCut.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ShortCut.xml. .. _class_ShortCut: diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 08e7301e5..1c3453ca5 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Skeleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Skeleton.xml. .. _class_Skeleton: diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index d0066ed27..fd975d5d5 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Skeleton2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Skeleton2D.xml. .. _class_Skeleton2D: diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 075024ada..9dd0a256c 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SkeletonIK.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SkeletonIK.xml. .. _class_SkeletonIK: diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 6c9cdeb57..b77ea7b72 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Skin.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Skin.xml. .. _class_Skin: diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index aeac6c886..7ab8fc581 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SkinReference.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SkinReference.xml. .. _class_SkinReference: diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 140dd12ac..b20a3550a 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Sky.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Sky.xml. .. _class_Sky: diff --git a/classes/class_slider.rst b/classes/class_slider.rst index fb0e2032c..7de602aa6 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Slider.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Slider.xml. .. _class_Slider: diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 8d6b2fa4d..6e09cc949 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SliderJoint.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SliderJoint.xml. .. _class_SliderJoint: diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index d07050b8e..6f6bfac1d 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SoftBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SoftBody.xml. .. _class_SoftBody: diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index f07a762d3..01f9de922 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Spatial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Spatial.xml. .. _class_Spatial: @@ -12,7 +12,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`ARVRAnchor`, :ref:`ARVRController`, :ref:`ARVROrigin`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment`, :ref:`Camera`, :ref:`CollisionObject`, :ref:`CollisionPolygon`, :ref:`CollisionShape`, :ref:`CullInstance`, :ref:`GridMap`, :ref:`Joint`, :ref:`Listener`, :ref:`Navigation`, :ref:`NavigationMeshInstance`, :ref:`Occluder`, :ref:`Path`, :ref:`PathFollow`, :ref:`Portal`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RayCast`, :ref:`RemoteTransform`, :ref:`Room`, :ref:`RoomGroup`, :ref:`RoomManager`, :ref:`ShapeCast`, :ref:`Skeleton`, :ref:`SpringArm`, :ref:`VehicleWheel` +**Inherited By:** :ref:`ARVRAnchor`, :ref:`ARVRController`, :ref:`ARVROrigin`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment`, :ref:`Camera`, :ref:`CollisionObject`, :ref:`CollisionPolygon`, :ref:`CollisionShape`, :ref:`CullInstance`, :ref:`GridMap`, :ref:`Joint`, :ref:`Listener`, :ref:`LOD`, :ref:`MergeGroup`, :ref:`Navigation`, :ref:`NavigationMeshInstance`, :ref:`Occluder`, :ref:`Path`, :ref:`PathFollow`, :ref:`Portal`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RayCast`, :ref:`RemoteTransform`, :ref:`Room`, :ref:`RoomGroup`, :ref:`RoomManager`, :ref:`ShapeCast`, :ref:`Skeleton`, :ref:`SpringArm`, :ref:`VehicleWheel` Most basic 3D game object, parent of all 3D-related nodes. @@ -44,27 +44,35 @@ Properties .. table:: :widths: auto - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`SpatialGizmo` | :ref:`gizmo` | | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`global_rotation` | | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Transform` | :ref:`global_transform` | | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`global_translation` | | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`rotation` | | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`rotation_degrees` | ``Vector3( 0, 0, 0 )`` | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`scale` | ``Vector3( 1, 1, 1 )`` | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Transform` | :ref:`transform` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`Vector3` | :ref:`translation` | ``Vector3( 0, 0, 0 )`` | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ - | :ref:`bool` | :ref:`visible` | ``true`` | - +-----------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`SpatialGizmo` | :ref:`gizmo` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`global_position` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`global_rotation` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform` | :ref:`global_transform` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`global_translation` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`float` | :ref:`lod_range` | ``10.0`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`MergingMode` | :ref:`merging_mode` | ``0`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`position` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`rotation` | | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`rotation_degrees` | ``Vector3( 0, 0, 0 )`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`scale` | ``Vector3( 1, 1, 1 )`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Transform` | :ref:`transform` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Vector3` | :ref:`translation` | ``Vector3( 0, 0, 0 )`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`bool` | :ref:`visible` | ``true`` | + +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -191,6 +199,45 @@ Emitted when node visibility changes. .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_Spatial_MergingMode: + +.. rst-class:: classref-enumeration + +enum **MergingMode**: + +.. _class_Spatial_constant_MERGING_MODE_INHERIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`MergingMode` **MERGING_MODE_INHERIT** = ``0`` + +Inherits merging mode from the node's parent. For the root node, it is equivalent to :ref:`MERGING_MODE_ON`. Default. + +.. _class_Spatial_constant_MERGING_MODE_OFF: + +.. rst-class:: classref-enumeration-constant + +:ref:`MergingMode` **MERGING_MODE_OFF** = ``1`` + +Turn off merging in this node and children set to :ref:`MERGING_MODE_INHERIT`. + +.. _class_Spatial_constant_MERGING_MODE_ON: + +.. rst-class:: classref-enumeration-constant + +:ref:`MergingMode` **MERGING_MODE_ON** = ``2`` + +Turn on merging in this node and children set to :ref:`MERGING_MODE_INHERIT`. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Constants --------- @@ -270,6 +317,23 @@ The :ref:`SpatialGizmo` for this node. Used for example in : ---- +.. _class_Spatial_property_global_position: + +.. rst-class:: classref-property + +:ref:`Vector3` **global_position** + +.. rst-class:: classref-property-setget + +- void **set_global_translation** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_global_translation** **(** **)** + +Global position of this node. This is a forward-compatible alias for :ref:`global_translation`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Spatial_property_global_rotation: .. rst-class:: classref-property @@ -323,6 +387,63 @@ Global position of this node. This is equivalent to ``global_transform.origin``. ---- +.. _class_Spatial_property_lod_range: + +.. rst-class:: classref-property + +:ref:`float` **lod_range** = ``10.0`` + +.. rst-class:: classref-property-setget + +- void **set_lod_range** **(** :ref:`float` value **)** +- :ref:`float` **get_lod_range** **(** **)** + +Determines the threshold distance at which this node will be shown or hidden when this node is parented by a :ref:`LOD` node. + +For example, a first child with a range of ``2`` will be shown from distance 0 to 2. A second child with a range of ``5`` will be shown from distance 2 to 7, etc. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Spatial_property_merging_mode: + +.. rst-class:: classref-property + +:ref:`MergingMode` **merging_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_merging_mode** **(** :ref:`MergingMode` value **)** +- :ref:`MergingMode` **get_merging_mode** **(** **)** + +The merging mode determines whether merging features of the engine (:ref:`MergeGroup` and :ref:`RoomManager`) will attempt to operate on branches of the scene tree. + +The default mode inherited from the scene tree root is :ref:`MERGING_MODE_ON`. + +\ **Note:** Merging mode determines whether the merging is **allowed** to be performed. It does not guarantee that merging will occur, which depends on whether there are suitable matching objects. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Spatial_property_position: + +.. rst-class:: classref-property + +:ref:`Vector3` **position** + +.. rst-class:: classref-property-setget + +- void **set_translation** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_translation** **(** **)** + +Local position of this node. This is a forward-compatible alias for :ref:`translation`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Spatial_property_rotation: .. rst-class:: classref-property @@ -425,7 +546,7 @@ Local translation of this node. - void **set_visible** **(** :ref:`bool` value **)** - :ref:`bool` **is_visible** **(** **)** -If ``true``, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). +If ``true``, this node is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree` must return ``true``). .. rst-class:: classref-section-separator @@ -458,6 +579,8 @@ When using physics interpolation, there will be circumstances in which you want This is particularly important for frame-based operations that take place in :ref:`Node._process`, rather than :ref:`Node._physics_process`. Examples include :ref:`Camera`\ s focusing on a node, or finding where to fire lasers from on a frame rather than physics tick. +\ **Note:** This function creates an interpolation pump on the **Spatial** the first time it is called, which can respond to physics interpolation resets. If you get problems with "streaking" when initially following a **Spatial**, be sure to call :ref:`get_global_transform_interpolated` at least once *before* resetting the **Spatial** physics interpolation. + .. rst-class:: classref-item-separator ---- @@ -588,7 +711,7 @@ Returns whether the node notifies about its global and local transformation chan :ref:`bool` **is_visible_in_tree** **(** **)** |const| -Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. +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. .. rst-class:: classref-item-separator diff --git a/classes/class_spatialgizmo.rst b/classes/class_spatialgizmo.rst index c54b021db..a4f751fd5 100644 --- a/classes/class_spatialgizmo.rst +++ b/classes/class_spatialgizmo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpatialGizmo.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpatialGizmo.xml. .. _class_SpatialGizmo: diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index efe216f44..948e22349 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -2,17 +2,17 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpatialMaterial.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpatialMaterial.xml. .. _class_SpatialMaterial: SpatialMaterial =============== -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Material3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -Default 3D rendering material. +Default 3D rendering material, based on :ref:`Material3D`. .. rst-class:: classref-introduction-group @@ -28,2996 +28,6 @@ Tutorials - :doc:`../tutorials/3d/spatial_material` -.. rst-class:: classref-reftable-group - -Properties ----------- - -.. table:: - :widths: auto - - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`albedo_color` | ``Color( 1, 1, 1, 1 )`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`albedo_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`anisotropy` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`anisotropy_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`anisotropy_flowmap` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`ao_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`ao_light_affect` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`ao_on_uv2` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`ao_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`TextureChannel` | :ref:`ao_texture_channel` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`AsyncMode` | :ref:`async_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`clearcoat` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`clearcoat_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`clearcoat_gloss` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`clearcoat_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`depth_deep_parallax` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`depth_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`depth_flip_binormal` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`depth_flip_tangent` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`depth_max_layers` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`depth_min_layers` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`depth_scale` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`depth_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`detail_albedo` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`BlendMode` | :ref:`detail_blend_mode` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`detail_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`detail_mask` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`detail_normal` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`DetailUV` | :ref:`detail_uv_layer` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`distance_fade_max_distance` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`distance_fade_min_distance` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`DistanceFadeMode` | :ref:`distance_fade_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`emission` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`emission_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`emission_energy` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`emission_on_uv2` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`EmissionOperator` | :ref:`emission_operator` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`emission_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_albedo_tex_force_srgb` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_albedo_tex_msdf` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_disable_ambient_light` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_do_not_receive_shadows` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_ensure_correct_normals` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_fixed_size` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_no_depth_test` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_transparent` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_unshaded` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_use_point_size` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_use_shadow_to_opacity` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_vertex_lighting` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flags_world_triplanar` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`metallic` | ``0.0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`metallic_specular` | ``0.5`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`metallic_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`TextureChannel` | :ref:`metallic_texture_channel` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`normal_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`normal_scale` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`normal_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`params_alpha_scissor_threshold` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`params_billboard_keep_scale` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`BillboardMode` | :ref:`params_billboard_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`BlendMode` | :ref:`params_blend_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`CullMode` | :ref:`params_cull_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`DepthDrawMode` | :ref:`params_depth_draw_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`DiffuseMode` | :ref:`params_diffuse_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`params_grow` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`params_grow_amount` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`params_line_width` | ``1.0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`params_point_size` | ``1.0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`SpecularMode` | :ref:`params_specular_mode` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`params_use_alpha_scissor` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`particles_anim_h_frames` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`particles_anim_loop` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`particles_anim_v_frames` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`proximity_fade_distance` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`proximity_fade_enable` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`refraction_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`refraction_scale` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`refraction_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`TextureChannel` | :ref:`refraction_texture_channel` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`rim` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`rim_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`rim_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`rim_tint` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`roughness` | ``1.0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`roughness_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`TextureChannel` | :ref:`roughness_texture_channel` | ``0`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`subsurf_scatter_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`subsurf_scatter_strength` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`subsurf_scatter_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`transmission` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`transmission_enabled` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Texture` | :ref:`transmission_texture` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector3` | :ref:`uv1_offset` | ``Vector3( 0, 0, 0 )`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector3` | :ref:`uv1_scale` | ``Vector3( 1, 1, 1 )`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`uv1_triplanar` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`uv1_triplanar_sharpness` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector3` | :ref:`uv2_offset` | ``Vector3( 0, 0, 0 )`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`Vector3` | :ref:`uv2_scale` | ``Vector3( 1, 1, 1 )`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`uv2_triplanar` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`uv2_triplanar_sharpness` | | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`vertex_color_is_srgb` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ``false`` | - +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - -.. rst-class:: classref-reftable-group - -Methods -------- - -.. table:: - :widths: auto - - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** |const| | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_feature` **(** :ref:`Feature` feature, :ref:`bool` enable **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_texture` **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** | - +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Enumerations ------------- - -.. _enum_SpatialMaterial_TextureParam: - -.. rst-class:: classref-enumeration - -enum **TextureParam**: - -.. _class_SpatialMaterial_constant_TEXTURE_ALBEDO: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_ALBEDO** = ``0`` - -Texture specifying per-pixel color. - -.. _class_SpatialMaterial_constant_TEXTURE_METALLIC: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_METALLIC** = ``1`` - -Texture specifying per-pixel metallic value. - -.. _class_SpatialMaterial_constant_TEXTURE_ROUGHNESS: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_ROUGHNESS** = ``2`` - -Texture specifying per-pixel roughness value. - -.. _class_SpatialMaterial_constant_TEXTURE_EMISSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_EMISSION** = ``3`` - -Texture specifying per-pixel emission color. - -.. _class_SpatialMaterial_constant_TEXTURE_NORMAL: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_NORMAL** = ``4`` - -Texture specifying per-pixel normal vector. - -.. _class_SpatialMaterial_constant_TEXTURE_RIM: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_RIM** = ``5`` - -Texture specifying per-pixel rim value. - -.. _class_SpatialMaterial_constant_TEXTURE_CLEARCOAT: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_CLEARCOAT** = ``6`` - -Texture specifying per-pixel clearcoat value. - -.. _class_SpatialMaterial_constant_TEXTURE_FLOWMAP: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_FLOWMAP** = ``7`` - -Texture specifying per-pixel flowmap direction for use with :ref:`anisotropy`. - -.. _class_SpatialMaterial_constant_TEXTURE_AMBIENT_OCCLUSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_AMBIENT_OCCLUSION** = ``8`` - -Texture specifying per-pixel ambient occlusion value. - -.. _class_SpatialMaterial_constant_TEXTURE_DEPTH: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_DEPTH** = ``9`` - -Texture specifying per-pixel depth. - -.. _class_SpatialMaterial_constant_TEXTURE_SUBSURFACE_SCATTERING: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_SUBSURFACE_SCATTERING** = ``10`` - -Texture specifying per-pixel subsurface scattering. - -.. _class_SpatialMaterial_constant_TEXTURE_TRANSMISSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_TRANSMISSION** = ``11`` - -Texture specifying per-pixel transmission color. - -.. _class_SpatialMaterial_constant_TEXTURE_REFRACTION: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_REFRACTION** = ``12`` - -Texture specifying per-pixel refraction strength. - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_MASK: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_DETAIL_MASK** = ``13`` - -Texture specifying per-pixel detail mask blending value. - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_ALBEDO: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_DETAIL_ALBEDO** = ``14`` - -Texture specifying per-pixel detail color. - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_NORMAL: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_DETAIL_NORMAL** = ``15`` - -Texture specifying per-pixel detail normal. - -.. _class_SpatialMaterial_constant_TEXTURE_MAX: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureParam` **TEXTURE_MAX** = ``16`` - -Represents the size of the :ref:`TextureParam` enum. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_DetailUV: - -.. rst-class:: classref-enumeration - -enum **DetailUV**: - -.. _class_SpatialMaterial_constant_DETAIL_UV_1: - -.. rst-class:: classref-enumeration-constant - -:ref:`DetailUV` **DETAIL_UV_1** = ``0`` - -Use ``UV`` with the detail texture. - -.. _class_SpatialMaterial_constant_DETAIL_UV_2: - -.. rst-class:: classref-enumeration-constant - -:ref:`DetailUV` **DETAIL_UV_2** = ``1`` - -Use ``UV2`` with the detail texture. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_Feature: - -.. rst-class:: classref-enumeration - -enum **Feature**: - -.. _class_SpatialMaterial_constant_FEATURE_TRANSPARENT: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_TRANSPARENT** = ``0`` - -Constant for setting :ref:`flags_transparent`. - -.. _class_SpatialMaterial_constant_FEATURE_EMISSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_EMISSION** = ``1`` - -Constant for setting :ref:`emission_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_NORMAL_MAPPING: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_NORMAL_MAPPING** = ``2`` - -Constant for setting :ref:`normal_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_RIM: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_RIM** = ``3`` - -Constant for setting :ref:`rim_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_CLEARCOAT: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_CLEARCOAT** = ``4`` - -Constant for setting :ref:`clearcoat_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_ANISOTROPY: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_ANISOTROPY** = ``5`` - -Constant for setting :ref:`anisotropy_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_AMBIENT_OCCLUSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_AMBIENT_OCCLUSION** = ``6`` - -Constant for setting :ref:`ao_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_DEPTH_MAPPING: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_DEPTH_MAPPING** = ``7`` - -Constant for setting :ref:`depth_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_SUBSURACE_SCATTERING: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_SUBSURACE_SCATTERING** = ``8`` - -Constant for setting :ref:`subsurf_scatter_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_TRANSMISSION: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_TRANSMISSION** = ``9`` - -Constant for setting :ref:`transmission_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_REFRACTION: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_REFRACTION** = ``10`` - -Constant for setting :ref:`refraction_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_DETAIL: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_DETAIL** = ``11`` - -Constant for setting :ref:`detail_enabled`. - -.. _class_SpatialMaterial_constant_FEATURE_MAX: - -.. rst-class:: classref-enumeration-constant - -:ref:`Feature` **FEATURE_MAX** = ``12`` - -Represents the size of the :ref:`Feature` enum. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_BlendMode: - -.. rst-class:: classref-enumeration - -enum **BlendMode**: - -.. _class_SpatialMaterial_constant_BLEND_MODE_MIX: - -.. rst-class:: classref-enumeration-constant - -:ref:`BlendMode` **BLEND_MODE_MIX** = ``0`` - -Default blend mode. The color of the object is blended over the background based on the object's alpha value. - -.. _class_SpatialMaterial_constant_BLEND_MODE_ADD: - -.. rst-class:: classref-enumeration-constant - -:ref:`BlendMode` **BLEND_MODE_ADD** = ``1`` - -The color of the object is added to the background. - -.. _class_SpatialMaterial_constant_BLEND_MODE_SUB: - -.. rst-class:: classref-enumeration-constant - -:ref:`BlendMode` **BLEND_MODE_SUB** = ``2`` - -The color of the object is subtracted from the background. - -.. _class_SpatialMaterial_constant_BLEND_MODE_MUL: - -.. rst-class:: classref-enumeration-constant - -:ref:`BlendMode` **BLEND_MODE_MUL** = ``3`` - -The color of the object is multiplied by the background. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_DepthDrawMode: - -.. rst-class:: classref-enumeration - -enum **DepthDrawMode**: - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_OPAQUE_ONLY: - -.. rst-class:: classref-enumeration-constant - -:ref:`DepthDrawMode` **DEPTH_DRAW_OPAQUE_ONLY** = ``0`` - -Default depth draw mode. Depth is drawn only for opaque objects. - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALWAYS: - -.. rst-class:: classref-enumeration-constant - -:ref:`DepthDrawMode` **DEPTH_DRAW_ALWAYS** = ``1`` - -Depth draw is calculated for both opaque and transparent objects. - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_DISABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`DepthDrawMode` **DEPTH_DRAW_DISABLED** = ``2`` - -No depth draw. - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALPHA_OPAQUE_PREPASS: - -.. rst-class:: classref-enumeration-constant - -:ref:`DepthDrawMode` **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = ``3`` - -For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_CullMode: - -.. rst-class:: classref-enumeration - -enum **CullMode**: - -.. _class_SpatialMaterial_constant_CULL_BACK: - -.. rst-class:: classref-enumeration-constant - -:ref:`CullMode` **CULL_BACK** = ``0`` - -Default cull mode. The back of the object is culled when not visible. - -.. _class_SpatialMaterial_constant_CULL_FRONT: - -.. rst-class:: classref-enumeration-constant - -:ref:`CullMode` **CULL_FRONT** = ``1`` - -The front of the object is culled when not visible. - -.. _class_SpatialMaterial_constant_CULL_DISABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`CullMode` **CULL_DISABLED** = ``2`` - -No culling is performed. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_Flags: - -.. rst-class:: classref-enumeration - -enum **Flags**: - -.. _class_SpatialMaterial_constant_FLAG_UNSHADED: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_UNSHADED** = ``0`` - -No lighting is used on the object. Color comes directly from ``ALBEDO``. - -.. _class_SpatialMaterial_constant_FLAG_USE_VERTEX_LIGHTING: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_USE_VERTEX_LIGHTING** = ``1`` - -Lighting is calculated per-vertex rather than per-pixel. This can be used to increase the speed of the shader at the cost of quality. - -.. _class_SpatialMaterial_constant_FLAG_DISABLE_DEPTH_TEST: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_DISABLE_DEPTH_TEST** = ``2`` - -Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it. - -.. _class_SpatialMaterial_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_ALBEDO_FROM_VERTEX_COLOR** = ``3`` - -Set ``ALBEDO`` to the per-vertex color specified in the mesh. - -.. _class_SpatialMaterial_constant_FLAG_SRGB_VERTEX_COLOR: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_SRGB_VERTEX_COLOR** = ``4`` - -Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer. - -.. _class_SpatialMaterial_constant_FLAG_USE_POINT_SIZE: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_USE_POINT_SIZE** = ``5`` - -Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use ``POINT_COORD`` instead of ``UV``. - -.. _class_SpatialMaterial_constant_FLAG_FIXED_SIZE: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_FIXED_SIZE** = ``6`` - -Object is scaled by depth so that it always appears the same size on screen. - -.. _class_SpatialMaterial_constant_FLAG_BILLBOARD_KEEP_SCALE: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_BILLBOARD_KEEP_SCALE** = ``7`` - -Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`params_billboard_mode` is :ref:`BILLBOARD_ENABLED`. - -.. _class_SpatialMaterial_constant_FLAG_UV1_USE_TRIPLANAR: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_UV1_USE_TRIPLANAR** = ``8`` - -Use triplanar texture lookup for all texture lookups that would normally use ``UV``. - -.. _class_SpatialMaterial_constant_FLAG_UV2_USE_TRIPLANAR: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_UV2_USE_TRIPLANAR** = ``9`` - -Use triplanar texture lookup for all texture lookups that would normally use ``UV2``. - -.. _class_SpatialMaterial_constant_FLAG_AO_ON_UV2: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_AO_ON_UV2** = ``11`` - -Use ``UV2`` coordinates to look up from the :ref:`ao_texture`. - -.. _class_SpatialMaterial_constant_FLAG_EMISSION_ON_UV2: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_EMISSION_ON_UV2** = ``12`` - -Use ``UV2`` coordinates to look up from the :ref:`emission_texture`. - -.. _class_SpatialMaterial_constant_FLAG_USE_ALPHA_SCISSOR: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_USE_ALPHA_SCISSOR** = ``13`` - -Use alpha scissor. Set by :ref:`params_use_alpha_scissor`. - -.. _class_SpatialMaterial_constant_FLAG_TRIPLANAR_USE_WORLD: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_TRIPLANAR_USE_WORLD** = ``10`` - -Use world coordinates in the triplanar texture lookup instead of local coordinates. - -.. _class_SpatialMaterial_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = ``14`` - -Forces the shader to convert albedo from sRGB space to linear space. - -.. _class_SpatialMaterial_constant_FLAG_DONT_RECEIVE_SHADOWS: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_DONT_RECEIVE_SHADOWS** = ``15`` - -Disables receiving shadows from other objects. - -.. _class_SpatialMaterial_constant_FLAG_DISABLE_AMBIENT_LIGHT: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_DISABLE_AMBIENT_LIGHT** = ``17`` - -Disables receiving ambient light. - -.. _class_SpatialMaterial_constant_FLAG_ENSURE_CORRECT_NORMALS: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_ENSURE_CORRECT_NORMALS** = ``16`` - -Ensures that normals appear correct, even with non-uniform scaling. - -.. _class_SpatialMaterial_constant_FLAG_USE_SHADOW_TO_OPACITY: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_USE_SHADOW_TO_OPACITY** = ``18`` - -Enables the shadow to opacity feature. - -.. _class_SpatialMaterial_constant_FLAG_ALBEDO_TEXTURE_SDF: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_ALBEDO_TEXTURE_SDF** = ``19`` - -Enables signed distance field rendering shader. - -.. _class_SpatialMaterial_constant_FLAG_MAX: - -.. rst-class:: classref-enumeration-constant - -:ref:`Flags` **FLAG_MAX** = ``20`` - -Represents the size of the :ref:`Flags` enum. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_DiffuseMode: - -.. rst-class:: classref-enumeration - -enum **DiffuseMode**: - -.. _class_SpatialMaterial_constant_DIFFUSE_BURLEY: - -.. rst-class:: classref-enumeration-constant - -:ref:`DiffuseMode` **DIFFUSE_BURLEY** = ``0`` - -Default diffuse scattering algorithm. - -.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT: - -.. rst-class:: classref-enumeration-constant - -:ref:`DiffuseMode` **DIFFUSE_LAMBERT** = ``1`` - -Diffuse scattering ignores roughness. - -.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT_WRAP: - -.. rst-class:: classref-enumeration-constant - -:ref:`DiffuseMode` **DIFFUSE_LAMBERT_WRAP** = ``2`` - -Extends Lambert to cover more than 90 degrees when roughness increases. - -.. _class_SpatialMaterial_constant_DIFFUSE_OREN_NAYAR: - -.. rst-class:: classref-enumeration-constant - -:ref:`DiffuseMode` **DIFFUSE_OREN_NAYAR** = ``3`` - -Attempts to use roughness to emulate microsurfacing. - -.. _class_SpatialMaterial_constant_DIFFUSE_TOON: - -.. rst-class:: classref-enumeration-constant - -:ref:`DiffuseMode` **DIFFUSE_TOON** = ``4`` - -Uses a hard cut for lighting, with smoothing affected by roughness. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_SpecularMode: - -.. rst-class:: classref-enumeration - -enum **SpecularMode**: - -.. _class_SpatialMaterial_constant_SPECULAR_SCHLICK_GGX: - -.. rst-class:: classref-enumeration-constant - -:ref:`SpecularMode` **SPECULAR_SCHLICK_GGX** = ``0`` - -Default specular blob. - -.. _class_SpatialMaterial_constant_SPECULAR_BLINN: - -.. rst-class:: classref-enumeration-constant - -:ref:`SpecularMode` **SPECULAR_BLINN** = ``1`` - -Older specular algorithm, included for compatibility. - -.. _class_SpatialMaterial_constant_SPECULAR_PHONG: - -.. rst-class:: classref-enumeration-constant - -:ref:`SpecularMode` **SPECULAR_PHONG** = ``2`` - -Older specular algorithm, included for compatibility. - -.. _class_SpatialMaterial_constant_SPECULAR_TOON: - -.. rst-class:: classref-enumeration-constant - -:ref:`SpecularMode` **SPECULAR_TOON** = ``3`` - -Toon blob which changes size based on roughness. - -.. _class_SpatialMaterial_constant_SPECULAR_DISABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`SpecularMode` **SPECULAR_DISABLED** = ``4`` - -No specular blob. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_BillboardMode: - -.. rst-class:: classref-enumeration - -enum **BillboardMode**: - -.. _class_SpatialMaterial_constant_BILLBOARD_DISABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`BillboardMode` **BILLBOARD_DISABLED** = ``0`` - -Billboard mode is disabled. - -.. _class_SpatialMaterial_constant_BILLBOARD_ENABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`BillboardMode` **BILLBOARD_ENABLED** = ``1`` - -The object's Z axis will always face the camera. - -.. _class_SpatialMaterial_constant_BILLBOARD_FIXED_Y: - -.. rst-class:: classref-enumeration-constant - -:ref:`BillboardMode` **BILLBOARD_FIXED_Y** = ``2`` - -The object's X axis will always face the camera. - -.. _class_SpatialMaterial_constant_BILLBOARD_PARTICLES: - -.. rst-class:: classref-enumeration-constant - -:ref:`BillboardMode` **BILLBOARD_PARTICLES** = ``3`` - -Used for particle systems when assigned to :ref:`Particles` and :ref:`CPUParticles` nodes. Enables ``particles_anim_*`` properties. - -The :ref:`ParticlesMaterial.anim_speed` or :ref:`CPUParticles.anim_speed` should also be set to a positive value for the animation to play. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_TextureChannel: - -.. rst-class:: classref-enumeration - -enum **TextureChannel**: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_RED: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureChannel` **TEXTURE_CHANNEL_RED** = ``0`` - -Used to read from the red channel of a texture. - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GREEN: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureChannel` **TEXTURE_CHANNEL_GREEN** = ``1`` - -Used to read from the green channel of a texture. - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_BLUE: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureChannel` **TEXTURE_CHANNEL_BLUE** = ``2`` - -Used to read from the blue channel of a texture. - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_ALPHA: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureChannel` **TEXTURE_CHANNEL_ALPHA** = ``3`` - -Used to read from the alpha channel of a texture. - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GRAYSCALE: - -.. rst-class:: classref-enumeration-constant - -:ref:`TextureChannel` **TEXTURE_CHANNEL_GRAYSCALE** = ``4`` - -Currently unused. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_EmissionOperator: - -.. rst-class:: classref-enumeration - -enum **EmissionOperator**: - -.. _class_SpatialMaterial_constant_EMISSION_OP_ADD: - -.. rst-class:: classref-enumeration-constant - -:ref:`EmissionOperator` **EMISSION_OP_ADD** = ``0`` - -Adds the emission color to the color from the emission texture. - -.. _class_SpatialMaterial_constant_EMISSION_OP_MULTIPLY: - -.. rst-class:: classref-enumeration-constant - -:ref:`EmissionOperator` **EMISSION_OP_MULTIPLY** = ``1`` - -Multiplies the emission color by the color from the emission texture. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_DistanceFadeMode: - -.. rst-class:: classref-enumeration - -enum **DistanceFadeMode**: - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_DISABLED: - -.. rst-class:: classref-enumeration-constant - -:ref:`DistanceFadeMode` **DISTANCE_FADE_DISABLED** = ``0`` - -Do not use distance fade. - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_ALPHA: - -.. rst-class:: classref-enumeration-constant - -:ref:`DistanceFadeMode` **DISTANCE_FADE_PIXEL_ALPHA** = ``1`` - -Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel. - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_DITHER: - -.. rst-class:: classref-enumeration-constant - -:ref:`DistanceFadeMode` **DISTANCE_FADE_PIXEL_DITHER** = ``2`` - -Smoothly fades the object out based on each pixel's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA`. - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_OBJECT_DITHER: - -.. rst-class:: classref-enumeration-constant - -:ref:`DistanceFadeMode` **DISTANCE_FADE_OBJECT_DITHER** = ``3`` - -Smoothly fades the object out based on the object's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA`. - -.. rst-class:: classref-item-separator - ----- - -.. _enum_SpatialMaterial_AsyncMode: - -.. rst-class:: classref-enumeration - -enum **AsyncMode**: - -.. _class_SpatialMaterial_constant_ASYNC_MODE_VISIBLE: - -.. rst-class:: classref-enumeration-constant - -:ref:`AsyncMode` **ASYNC_MODE_VISIBLE** = ``0`` - -The real conditioned shader needed on each situation will be sent for background compilation. In the meantime, a very complex shader that adapts to every situation will be used ("ubershader"). This ubershader is much slower to render, but will keep the game running without stalling to compile. Once shader compilation is done, the ubershader is replaced by the traditional optimized shader. - -.. _class_SpatialMaterial_constant_ASYNC_MODE_HIDDEN: - -.. rst-class:: classref-enumeration-constant - -:ref:`AsyncMode` **ASYNC_MODE_HIDDEN** = ``1`` - -Anything with this material applied won't be rendered while this material's shader is being compiled. - -This is useful for optimization, in cases where the visuals won't suffer from having certain non-essential elements missing during the short time their shaders are being compiled. - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Property Descriptions ---------------------- - -.. _class_SpatialMaterial_property_albedo_color: - -.. rst-class:: classref-property - -:ref:`Color` **albedo_color** = ``Color( 1, 1, 1, 1 )`` - -.. rst-class:: classref-property-setget - -- void **set_albedo** **(** :ref:`Color` value **)** -- :ref:`Color` **get_albedo** **(** **)** - -The material's base color. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_albedo_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **albedo_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture to multiply by :ref:`albedo_color`. Used for basic texturing of objects. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_anisotropy: - -.. rst-class:: classref-property - -:ref:`float` **anisotropy** - -.. rst-class:: classref-property-setget - -- void **set_anisotropy** **(** :ref:`float` value **)** -- :ref:`float` **get_anisotropy** **(** **)** - -The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_flowmap`'s alpha channel if a texture is defined there and the texture contains an alpha channel. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_anisotropy_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **anisotropy_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections. - -\ **Note:** Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken. - -\ **Note:** Material anisotropy should not to be confused with anisotropic texture filtering. Anisotropic texture filtering can be enabled by selecting a texture in the FileSystem dock, going to the Import dock, checking the **Anisotropic** checkbox then clicking **Reimport**. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/quality/filters/anisotropic_filter_level`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_anisotropy_flowmap: - -.. rst-class:: classref-property - -:ref:`Texture` **anisotropy_flowmap** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion. - -If present, the texture's alpha channel will be used to multiply the strength of the :ref:`anisotropy` effect. Fully opaque pixels will keep the anisotropy effect's original strength while fully transparent pixels will disable the anisotropy effect entirely. The flowmap texture's blue channel is ignored. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_ao_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **ao_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_ao_light_affect: - -.. rst-class:: classref-property - -:ref:`float` **ao_light_affect** - -.. rst-class:: classref-property-setget - -- void **set_ao_light_affect** **(** :ref:`float` value **)** -- :ref:`float` **get_ao_light_affect** **(** **)** - -Amount that ambient occlusion affects lighting from lights. If ``0``, ambient occlusion only affects ambient light. If ``1``, ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_ao_on_uv2: - -.. rst-class:: classref-property - -:ref:`bool` **ao_on_uv2** - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_ao_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **ao_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that defines the amount of ambient occlusion for a given point on the object. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_ao_texture_channel: - -.. rst-class:: classref-property - -:ref:`TextureChannel` **ao_texture_channel** - -.. rst-class:: classref-property-setget - -- void **set_ao_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_ao_texture_channel** **(** **)** - -Specifies the channel of the :ref:`ao_texture` in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_async_mode: - -.. rst-class:: classref-property - -:ref:`AsyncMode` **async_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_async_mode** **(** :ref:`AsyncMode` value **)** -- :ref:`AsyncMode` **get_async_mode** **(** **)** - -If :ref:`ProjectSettings.rendering/gles3/shaders/shader_compilation_mode` is ``Synchronous`` (with or without cache), this determines how this material must behave in regards to asynchronous shader compilation. - -\ :ref:`ASYNC_MODE_VISIBLE` is the default and the best for most cases. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_clearcoat: - -.. rst-class:: classref-property - -:ref:`float` **clearcoat** - -.. rst-class:: classref-property-setget - -- void **set_clearcoat** **(** :ref:`float` value **)** -- :ref:`float` **get_clearcoat** **(** **)** - -Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_clearcoat_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **clearcoat_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough. - -\ **Note:** Clearcoat rendering is not visible if the material has :ref:`flags_unshaded` set to ``true``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_clearcoat_gloss: - -.. rst-class:: classref-property - -:ref:`float` **clearcoat_gloss** - -.. rst-class:: classref-property-setget - -- void **set_clearcoat_gloss** **(** :ref:`float` value **)** -- :ref:`float` **get_clearcoat_gloss** **(** **)** - -Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_clearcoat_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **clearcoat_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_deep_parallax: - -.. rst-class:: classref-property - -:ref:`bool` **depth_deep_parallax** - -.. rst-class:: classref-property-setget - -- void **set_depth_deep_parallax** **(** :ref:`bool` value **)** -- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** - -If ``true``, the shader will read depth texture at multiple points along the view ray to determine occlusion and parrallax. This can be very performance demanding, but results in more realistic looking depth mapping. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **depth_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also :ref:`normal_enabled`. - -\ **Note:** Depth mapping is not supported if triplanar mapping is used on the same material. The value of :ref:`depth_enabled` will be ignored if :ref:`uv1_triplanar` is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_flip_binormal: - -.. rst-class:: classref-property - -:ref:`bool` **depth_flip_binormal** - -.. rst-class:: classref-property-setget - -- void **set_depth_deep_parallax_flip_binormal** **(** :ref:`bool` value **)** -- :ref:`bool` **get_depth_deep_parallax_flip_binormal** **(** **)** - -If ``true``, direction of the binormal is flipped before using in the depth effect. This may be necessary if you have encoded your binormals in a way that is conflicting with the depth effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_flip_tangent: - -.. rst-class:: classref-property - -:ref:`bool` **depth_flip_tangent** - -.. rst-class:: classref-property-setget - -- void **set_depth_deep_parallax_flip_tangent** **(** :ref:`bool` value **)** -- :ref:`bool` **get_depth_deep_parallax_flip_tangent** **(** **)** - -If ``true``, direction of the tangent is flipped before using in the depth effect. This may be necessary if you have encoded your tangents in a way that is conflicting with the depth effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_max_layers: - -.. rst-class:: classref-property - -:ref:`int` **depth_max_layers** - -.. rst-class:: classref-property-setget - -- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** - -Number of layers to use when using :ref:`depth_deep_parallax` and the view direction is perpendicular to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_min_layers: - -.. rst-class:: classref-property - -:ref:`int` **depth_min_layers** - -.. rst-class:: classref-property-setget - -- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` value **)** -- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** - -Number of layers to use when using :ref:`depth_deep_parallax` and the view direction is parallel to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_scale: - -.. rst-class:: classref-property - -:ref:`float` **depth_scale** - -.. rst-class:: classref-property-setget - -- void **set_depth_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_depth_scale** **(** **)** - -Scales the depth offset effect. A higher number will create a larger depth. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_depth_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **depth_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to determine depth at a given pixel. Depth is always stored in the red channel. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_albedo: - -.. rst-class:: classref-property - -:ref:`Texture` **detail_albedo** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that specifies the color of the detail overlay. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_blend_mode: - -.. rst-class:: classref-property - -:ref:`BlendMode` **detail_blend_mode** - -.. rst-class:: classref-property-setget - -- void **set_detail_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_detail_blend_mode** **(** **)** - -Specifies how the :ref:`detail_albedo` should blend with the current ``ALBEDO``. See :ref:`BlendMode` for options. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **detail_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on :ref:`detail_mask`. This can be used to add variation to objects, or to blend between two different albedo/normal textures. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_mask: - -.. rst-class:: classref-property - -:ref:`Texture` **detail_mask** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to specify how the detail textures get blended with the base textures. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_normal: - -.. rst-class:: classref-property - -:ref:`Texture` **detail_normal** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that specifies the per-pixel normal of the detail overlay. - -\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_detail_uv_layer: - -.. rst-class:: classref-property - -:ref:`DetailUV` **detail_uv_layer** - -.. rst-class:: classref-property-setget - -- void **set_detail_uv** **(** :ref:`DetailUV` value **)** -- :ref:`DetailUV` **get_detail_uv** **(** **)** - -Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV` for options. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_distance_fade_max_distance: - -.. rst-class:: classref-property - -:ref:`float` **distance_fade_max_distance** - -.. rst-class:: classref-property-setget - -- void **set_distance_fade_max_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_max_distance** **(** **)** - -Distance at which the object appears fully opaque. - -\ **Note:** If ``distance_fade_max_distance`` is less than ``distance_fade_min_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_distance_fade_min_distance: - -.. rst-class:: classref-property - -:ref:`float` **distance_fade_min_distance** - -.. rst-class:: classref-property-setget - -- void **set_distance_fade_min_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_distance_fade_min_distance** **(** **)** - -Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible. - -\ **Note:** If ``distance_fade_min_distance`` is greater than ``distance_fade_max_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_distance_fade_mode: - -.. rst-class:: classref-property - -:ref:`DistanceFadeMode` **distance_fade_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_distance_fade** **(** :ref:`DistanceFadeMode` value **)** -- :ref:`DistanceFadeMode` **get_distance_fade** **(** **)** - -Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode`\ s. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission: - -.. rst-class:: classref-property - -:ref:`Color` **emission** - -.. rst-class:: classref-property-setget - -- void **set_emission** **(** :ref:`Color` value **)** -- :ref:`Color` **get_emission** **(** **)** - -The emitted light's color. See :ref:`emission_enabled`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **emission_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a :ref:`GIProbe` or :ref:`BakedLightmap` is used and this object is used in baked lighting. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission_energy: - -.. rst-class:: classref-property - -:ref:`float` **emission_energy** - -.. rst-class:: classref-property-setget - -- void **set_emission_energy** **(** :ref:`float` value **)** -- :ref:`float` **get_emission_energy** **(** **)** - -The emitted light's strength. See :ref:`emission_enabled`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission_on_uv2: - -.. rst-class:: classref-property - -:ref:`bool` **emission_on_uv2** - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -Use ``UV2`` to read from the :ref:`emission_texture`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission_operator: - -.. rst-class:: classref-property - -:ref:`EmissionOperator` **emission_operator** - -.. rst-class:: classref-property-setget - -- void **set_emission_operator** **(** :ref:`EmissionOperator` value **)** -- :ref:`EmissionOperator` **get_emission_operator** **(** **)** - -Sets how :ref:`emission` interacts with :ref:`emission_texture`. Can either add or multiply. See :ref:`EmissionOperator` for options. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_emission_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **emission_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that specifies how much surface emits light at a given point. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_albedo_tex_force_srgb: - -.. rst-class:: classref-property - -:ref:`bool` **flags_albedo_tex_force_srgb** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -Forces a conversion of the :ref:`albedo_texture` from sRGB space to linear space. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_albedo_tex_msdf: - -.. rst-class:: classref-property - -:ref:`bool` **flags_albedo_tex_msdf** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -Enables signed distance field rendering shader. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_disable_ambient_light: - -.. rst-class:: classref-property - -:ref:`bool` **flags_disable_ambient_light** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the object receives no ambient light. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_do_not_receive_shadows: - -.. rst-class:: classref-property - -:ref:`bool` **flags_do_not_receive_shadows** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the object receives no shadow that would otherwise be cast onto it. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_ensure_correct_normals: - -.. rst-class:: classref-property - -:ref:`bool` **flags_ensure_correct_normals** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the shader will compute extra operations to make sure the normal stays correct when using a non-uniform scale. Only enable if using non-uniform scaling. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_fixed_size: - -.. rst-class:: classref-property - -:ref:`bool` **flags_fixed_size** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the object is rendered at the same size regardless of distance. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_no_depth_test: - -.. rst-class:: classref-property - -:ref:`bool` **flags_no_depth_test** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, depth testing is disabled and the object will be drawn in render order. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_transparent: - -.. rst-class:: classref-property - -:ref:`bool` **flags_transparent** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, transparency is enabled on the body. See also :ref:`params_blend_mode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_unshaded: - -.. rst-class:: classref-property - -:ref:`bool` **flags_unshaded** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the object is unaffected by lighting. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_use_point_size: - -.. rst-class:: classref-property - -:ref:`bool` **flags_use_point_size** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, render point size can be changed. - -\ **Note:** This is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_use_shadow_to_opacity: - -.. rst-class:: classref-property - -:ref:`bool` **flags_use_shadow_to_opacity** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_vertex_lighting: - -.. rst-class:: classref-property - -:ref:`bool` **flags_vertex_lighting** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices, especially for meshes with a lower polygon count. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled. - -See also :ref:`ProjectSettings.rendering/quality/shading/force_vertex_shading` which can globally enable vertex shading on all materials. - -\ **Note:** By default, vertex shading is enforced on mobile platforms by :ref:`ProjectSettings.rendering/quality/shading/force_vertex_shading`'s ``mobile`` override. - -\ **Note:** :ref:`flags_vertex_lighting` has no effect if :ref:`flags_unshaded` is ``true``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_flags_world_triplanar: - -.. rst-class:: classref-property - -:ref:`bool` **flags_world_triplanar** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_metallic: - -.. rst-class:: classref-property - -:ref:`float` **metallic** = ``0.0`` - -.. rst-class:: classref-property-setget - -- void **set_metallic** **(** :ref:`float` value **)** -- :ref:`float` **get_metallic** **(** **)** - -A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between ``0`` and ``1`` should only be used for blending between metal and non-metal sections. To alter the amount of reflection use :ref:`roughness`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_metallic_specular: - -.. rst-class:: classref-property - -:ref:`float` **metallic_specular** = ``0.5`` - -.. rst-class:: classref-property-setget - -- void **set_specular** **(** :ref:`float` value **)** -- :ref:`float` **get_specular** **(** **)** - -Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources. - -\ **Note:** Unlike :ref:`metallic`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_metallic_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **metallic_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to specify metallic for an object. This is multiplied by :ref:`metallic`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_metallic_texture_channel: - -.. rst-class:: classref-property - -:ref:`TextureChannel` **metallic_texture_channel** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_metallic_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_metallic_texture_channel** **(** **)** - -Specifies the channel of the :ref:`metallic_texture` in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_normal_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **normal_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, normal mapping is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_normal_scale: - -.. rst-class:: classref-property - -:ref:`float` **normal_scale** - -.. rst-class:: classref-property-setget - -- void **set_normal_scale** **(** :ref:`float` value **)** -- :ref:`float` **get_normal_scale** **(** **)** - -The strength of the normal map's effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_normal_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **normal_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to specify the normal at a given pixel. The ``normal_texture`` only uses the red and green channels; the blue and alpha channels are ignored. The normal read from ``normal_texture`` is oriented around the surface normal provided by the :ref:`Mesh`. - -\ **Note:** The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with :ref:`SurfaceTool`, you can use :ref:`SurfaceTool.generate_normals` and :ref:`SurfaceTool.generate_tangents` to automatically generate normals and tangents respectively. - -\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_alpha_scissor_threshold: - -.. rst-class:: classref-property - -:ref:`float` **params_alpha_scissor_threshold** - -.. rst-class:: classref-property-setget - -- void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** -- :ref:`float` **get_alpha_scissor_threshold** **(** **)** - -Threshold at which the alpha scissor will discard values. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_billboard_keep_scale: - -.. rst-class:: classref-property - -:ref:`bool` **params_billboard_keep_scale** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`params_billboard_mode` is :ref:`BILLBOARD_ENABLED`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_billboard_mode: - -.. rst-class:: classref-property - -:ref:`BillboardMode` **params_billboard_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** - -Controls how the object faces the camera. See :ref:`BillboardMode`. - -\ **Note:** Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See `GitHub issue #41567 `__ for details. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_blend_mode: - -.. rst-class:: classref-property - -:ref:`BlendMode` **params_blend_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_blend_mode** **(** :ref:`BlendMode` value **)** -- :ref:`BlendMode` **get_blend_mode** **(** **)** - -The material's blend mode. - -\ **Note:** Values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_cull_mode: - -.. rst-class:: classref-property - -:ref:`CullMode` **params_cull_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_cull_mode** **(** :ref:`CullMode` value **)** -- :ref:`CullMode` **get_cull_mode** **(** **)** - -Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_depth_draw_mode: - -.. rst-class:: classref-property - -:ref:`DepthDrawMode` **params_depth_draw_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_depth_draw_mode** **(** :ref:`DepthDrawMode` value **)** -- :ref:`DepthDrawMode` **get_depth_draw_mode** **(** **)** - -Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_diffuse_mode: - -.. rst-class:: classref-property - -:ref:`DiffuseMode` **params_diffuse_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_diffuse_mode** **(** :ref:`DiffuseMode` value **)** -- :ref:`DiffuseMode` **get_diffuse_mode** **(** **)** - -The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_grow: - -.. rst-class:: classref-property - -:ref:`bool` **params_grow** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_grow_enabled** **(** :ref:`bool` value **)** -- :ref:`bool` **is_grow_enabled** **(** **)** - -If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_grow_amount: - -.. rst-class:: classref-property - -:ref:`float` **params_grow_amount** - -.. rst-class:: classref-property-setget - -- void **set_grow** **(** :ref:`float` value **)** -- :ref:`float` **get_grow** **(** **)** - -Grows object vertices in the direction of their normals. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_line_width: - -.. rst-class:: classref-property - -:ref:`float` **params_line_width** = ``1.0`` - -.. rst-class:: classref-property-setget - -- void **set_line_width** **(** :ref:`float` value **)** -- :ref:`float` **get_line_width** **(** **)** - -Currently unimplemented in Godot. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_point_size: - -.. rst-class:: classref-property - -:ref:`float` **params_point_size** = ``1.0`` - -.. rst-class:: classref-property-setget - -- void **set_point_size** **(** :ref:`float` value **)** -- :ref:`float` **get_point_size** **(** **)** - -The point size in pixels. See :ref:`flags_use_point_size`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_specular_mode: - -.. rst-class:: classref-property - -:ref:`SpecularMode` **params_specular_mode** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_specular_mode** **(** :ref:`SpecularMode` value **)** -- :ref:`SpecularMode` **get_specular_mode** **(** **)** - -The method for rendering the specular blob. See :ref:`SpecularMode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_params_use_alpha_scissor: - -.. rst-class:: classref-property - -:ref:`bool` **params_use_alpha_scissor** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the shader will discard all pixels that have an alpha value less than :ref:`params_alpha_scissor_threshold`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_particles_anim_h_frames: - -.. rst-class:: classref-property - -:ref:`int` **particles_anim_h_frames** - -.. rst-class:: classref-property-setget - -- void **set_particles_anim_h_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_h_frames** **(** **)** - -The number of horizontal frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_particles_anim_loop: - -.. rst-class:: classref-property - -:ref:`bool` **particles_anim_loop** - -.. rst-class:: classref-property-setget - -- void **set_particles_anim_loop** **(** :ref:`bool` value **)** -- :ref:`bool` **get_particles_anim_loop** **(** **)** - -If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_particles_anim_v_frames: - -.. rst-class:: classref-property - -:ref:`int` **particles_anim_v_frames** - -.. rst-class:: classref-property-setget - -- void **set_particles_anim_v_frames** **(** :ref:`int` value **)** -- :ref:`int` **get_particles_anim_v_frames** **(** **)** - -The number of vertical frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_proximity_fade_distance: - -.. rst-class:: classref-property - -:ref:`float` **proximity_fade_distance** - -.. rst-class:: classref-property-setget - -- void **set_proximity_fade_distance** **(** :ref:`float` value **)** -- :ref:`float` **get_proximity_fade_distance** **(** **)** - -Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_proximity_fade_enable: - -.. rst-class:: classref-property - -:ref:`bool` **proximity_fade_enable** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_proximity_fade** **(** :ref:`bool` value **)** -- :ref:`bool` **is_proximity_fade_enabled** **(** **)** - -If ``true``, the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_refraction_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **refraction_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, the refraction effect is enabled. Refraction distorts transparency based on light from behind the object. When using the GLES3 backend, the material's roughness value will affect the blurriness of the refraction. Higher roughness values will make the refraction look blurrier. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_refraction_scale: - -.. rst-class:: classref-property - -:ref:`float` **refraction_scale** - -.. rst-class:: classref-property-setget - -- void **set_refraction** **(** :ref:`float` value **)** -- :ref:`float` **get_refraction** **(** **)** - -The strength of the refraction effect. Higher values result in a more distorted appearance for the refraction. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_refraction_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **refraction_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_refraction_texture_channel: - -.. rst-class:: classref-property - -:ref:`TextureChannel` **refraction_texture_channel** - -.. rst-class:: classref-property-setget - -- void **set_refraction_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_refraction_texture_channel** **(** **)** - -Specifies the channel of the :ref:`refraction_texture` in which the refraction information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_rim: - -.. rst-class:: classref-property - -:ref:`float` **rim** - -.. rst-class:: classref-property-setget - -- void **set_rim** **(** :ref:`float` value **)** -- :ref:`float` **get_rim** **(** **)** - -Sets the strength of the rim lighting effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_rim_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **rim_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. - -\ **Note:** Rim lighting is not visible if the material has :ref:`flags_unshaded` set to ``true``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_rim_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **rim_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_rim_tint: - -.. rst-class:: classref-property - -:ref:`float` **rim_tint** - -.. rst-class:: classref-property-setget - -- void **set_rim_tint** **(** :ref:`float` value **)** -- :ref:`float` **get_rim_tint** **(** **)** - -The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_roughness: - -.. rst-class:: classref-property - -:ref:`float` **roughness** = ``1.0`` - -.. rst-class:: classref-property-setget - -- void **set_roughness** **(** :ref:`float` value **)** -- :ref:`float` **get_roughness** **(** **)** - -Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_roughness_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **roughness_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_roughness_texture_channel: - -.. rst-class:: classref-property - -:ref:`TextureChannel` **roughness_texture_channel** = ``0`` - -.. rst-class:: classref-property-setget - -- void **set_roughness_texture_channel** **(** :ref:`TextureChannel` value **)** -- :ref:`TextureChannel` **get_roughness_texture_channel** **(** **)** - -Specifies the channel of the :ref:`ao_texture` in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **subsurf_scatter_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_strength: - -.. rst-class:: classref-property - -:ref:`float` **subsurf_scatter_strength** - -.. rst-class:: classref-property-setget - -- void **set_subsurface_scattering_strength** **(** :ref:`float` value **)** -- :ref:`float` **get_subsurface_scattering_strength** **(** **)** - -The strength of the subsurface scattering effect. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **subsurf_scatter_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_transmission: - -.. rst-class:: classref-property - -:ref:`Color` **transmission** - -.. rst-class:: classref-property-setget - -- void **set_transmission** **(** :ref:`Color` value **)** -- :ref:`Color` **get_transmission** **(** **)** - -The color used by the transmission effect. Represents the light passing through an object. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_transmission_enabled: - -.. rst-class:: classref-property - -:ref:`bool` **transmission_enabled** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -If ``true``, the transmission effect is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_transmission_texture: - -.. rst-class:: classref-property - -:ref:`Texture` **transmission_texture** - -.. rst-class:: classref-property-setget - -- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Texture used to control the transmission effect per-pixel. Added to :ref:`transmission`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv1_offset: - -.. rst-class:: classref-property - -:ref:`Vector3` **uv1_offset** = ``Vector3( 0, 0, 0 )`` - -.. rst-class:: classref-property-setget - -- void **set_uv1_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv1_offset** **(** **)** - -How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` in the vertex function. This can be used to offset a texture. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv1_scale: - -.. rst-class:: classref-property - -:ref:`Vector3` **uv1_scale** = ``Vector3( 1, 1, 1 )`` - -.. rst-class:: classref-property-setget - -- void **set_uv1_scale** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv1_scale** **(** **)** - -How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv1_triplanar: - -.. rst-class:: classref-property - -:ref:`bool` **uv1_triplanar** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, instead of using ``UV`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv1_triplanar_sharpness: - -.. rst-class:: classref-property - -:ref:`float` **uv1_triplanar_sharpness** - -.. rst-class:: classref-property-setget - -- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** - -A lower number blends the texture more softly while a higher number blends the texture more sharply. - -\ **Note:** :ref:`uv1_triplanar_sharpness` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv2_offset: - -.. rst-class:: classref-property - -:ref:`Vector3` **uv2_offset** = ``Vector3( 0, 0, 0 )`` - -.. rst-class:: classref-property-setget - -- void **set_uv2_offset** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv2_offset** **(** **)** - -How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` in the vertex function. This can be used to offset a texture. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv2_scale: - -.. rst-class:: classref-property - -:ref:`Vector3` **uv2_scale** = ``Vector3( 1, 1, 1 )`` - -.. rst-class:: classref-property-setget - -- void **set_uv2_scale** **(** :ref:`Vector3` value **)** -- :ref:`Vector3` **get_uv2_scale** **(** **)** - -How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv2_triplanar: - -.. rst-class:: classref-property - -:ref:`bool` **uv2_triplanar** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, instead of using ``UV2`` textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_uv2_triplanar_sharpness: - -.. rst-class:: classref-property - -:ref:`float` **uv2_triplanar_sharpness** - -.. rst-class:: classref-property-setget - -- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` value **)** -- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** - -A lower number blends the texture more softly while a higher number blends the texture more sharply. - -\ **Note:** :ref:`uv2_triplanar_sharpness` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_vertex_color_is_srgb: - -.. rst-class:: classref-property - -:ref:`bool` **vertex_color_is_srgb** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the model's vertex colors are processed as sRGB mode. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_property_vertex_color_use_as_albedo: - -.. rst-class:: classref-property - -:ref:`bool` **vertex_color_use_as_albedo** = ``false`` - -.. rst-class:: classref-property-setget - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -If ``true``, the vertex color is used as albedo color. - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Method Descriptions -------------------- - -.. _class_SpatialMaterial_method_get_feature: - -.. rst-class:: classref-method - -:ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** |const| - -Returns ``true``, if the specified :ref:`Feature` is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_method_get_flag: - -.. rst-class:: classref-method - -:ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** |const| - -Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_method_get_texture: - -.. rst-class:: classref-method - -:ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** |const| - -Returns the :ref:`Texture` associated with the specified :ref:`TextureParam`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_method_set_feature: - -.. rst-class:: classref-method - -void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** - -If ``true``, enables the specified :ref:`Feature`. Many features that are available in **SpatialMaterial**\ 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``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_method_set_flag: - -.. rst-class:: classref-method - -void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** - -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. - -.. rst-class:: classref-item-separator - ----- - -.. _class_SpatialMaterial_method_set_texture: - -.. rst-class:: classref-method - -void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture` texture **)** - -Sets the :ref:`Texture` to be used by the specified :ref:`TextureParam`. This function is called when setting members ending in ``*_texture``. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index 0fe9fb71e..4f6022b9d 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpatialVelocityTracker.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpatialVelocityTracker.xml. .. _class_SpatialVelocityTracker: diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index de16ecd7c..2d8e54035 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SphereMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SphereMesh.xml. .. _class_SphereMesh: diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index e7240732e..b6d24185f 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SphereShape.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SphereShape.xml. .. _class_SphereShape: diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index c4f873f49..5e66d244d 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpinBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpinBox.xml. .. _class_SpinBox: diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index fad662826..c0759a0b5 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SplitContainer.xml. .. _class_SplitContainer: diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index f305897be..49e778610 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpotLight.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpotLight.xml. .. _class_SpotLight: diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index f7867d91c..5b1eca8dd 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpringArm.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpringArm.xml. .. _class_SpringArm: diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 857f7690a..f1484675d 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Sprite.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Sprite.xml. .. _class_Sprite: diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 91c346f13..602ea7108 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Sprite3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Sprite3D.xml. .. _class_Sprite3D: diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index e9dffbde4..6a24b611b 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpriteBase3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpriteBase3D.xml. .. _class_SpriteBase3D: @@ -31,39 +31,39 @@ Properties .. table:: :widths: auto - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`AlphaCutMode` | :ref:`alpha_cut` | ``0`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | Vector3.Axis | :ref:`axis` | ``2`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`centered` | ``true`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`double_sided` | ``true`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`fixed_size` | ``false`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flip_h` | ``false`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`flip_v` | ``false`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`no_depth_test` | ``false`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`opacity` | ``1.0`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`pixel_size` | ``0.01`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`int` | :ref:`render_priority` | ``0`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`shaded` | ``false`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ - | :ref:`bool` | :ref:`transparent` | ``true`` | - +----------------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`AlphaCutMode` | :ref:`alpha_cut` | ``0`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | Vector3.Axis | :ref:`axis` | ``2`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`centered` | ``true`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`double_sided` | ``true`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`fixed_size` | ``false`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flip_h` | ``false`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`flip_v` | ``false`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`no_depth_test` | ``false`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`opacity` | ``1.0`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`pixel_size` | ``0.01`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`render_priority` | ``0`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`shaded` | ``false`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`transparent` | ``true`` | + +-----------------------------------------------------+---------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group @@ -229,12 +229,12 @@ The direction in which the front of the texture faces. .. rst-class:: classref-property -:ref:`BillboardMode` **billboard** = ``0`` +:ref:`BillboardMode` **billboard** = ``0`` .. rst-class:: classref-property-setget -- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** -- :ref:`BillboardMode` **get_billboard_mode** **(** **)** +- void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** +- :ref:`BillboardMode` **get_billboard_mode** **(** **)** .. container:: contribute @@ -342,7 +342,7 @@ If ``true``, texture is flipped vertically. A color value used to *multiply* the texture's colors. Can be used for mood-coloring or to simulate the color of light. -\ **Note:** If a :ref:`GeometryInstance.material_override` is defined on the **SpriteBase3D**, the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in :ref:`modulate` will be ignored. For a :ref:`SpatialMaterial`, :ref:`SpatialMaterial.vertex_color_use_as_albedo` must be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. +\ **Note:** If a :ref:`GeometryInstance.material_override` is defined on the **SpriteBase3D**, the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in :ref:`modulate` will be ignored. For a :ref:`SpatialMaterial`, :ref:`Material3D.vertex_color_use_as_albedo` must be ``true``. For a :ref:`ShaderMaterial`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. .. rst-class:: classref-item-separator @@ -395,7 +395,7 @@ The texture's drawing offset. The texture's visibility on a scale from ``0`` (fully invisible) to ``1`` (fully visible). :ref:`opacity` is a multiplier for the :ref:`modulate` color's alpha channel. -\ **Note:** If a :ref:`GeometryInstance.material_override` is defined on the **SpriteBase3D**, the material override must be configured to take vertex colors into account for albedo. Otherwise, the opacity defined in :ref:`opacity` will be ignored. For a :ref:`SpatialMaterial`, :ref:`SpatialMaterial.vertex_color_use_as_albedo` must be ``true``. For a :ref:`ShaderMaterial`, ``ALPHA *= COLOR.a;`` must be inserted in the shader's ``fragment()`` function. +\ **Note:** If a :ref:`GeometryInstance.material_override` is defined on the **SpriteBase3D**, the material override must be configured to take vertex colors into account for albedo. Otherwise, the opacity defined in :ref:`opacity` will be ignored. For a :ref:`SpatialMaterial`, :ref:`Material3D.vertex_color_use_as_albedo` must be ``true``. For a :ref:`ShaderMaterial`, ``ALPHA *= COLOR.a;`` must be inserted in the shader's ``fragment()`` function. .. rst-class:: classref-item-separator diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index c7ad1fbf1..33b6dafff 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SpriteFrames.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SpriteFrames.xml. .. _class_SpriteFrames: diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 964611f9d..fd3bae726 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StaticBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StaticBody.xml. .. _class_StaticBody: @@ -25,9 +25,11 @@ A static body is a simple body that doesn't move under physics simulation, i.e. They have extra functionalities to move and affect other bodies: -\ **Static transform change:** Static bodies can be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. +\ *Static transform change:* Static bodies can be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path. -\ **Constant velocity:** When :ref:`constant_linear_velocity` or :ref:`constant_angular_velocity` is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels. +\ *Constant velocity:* When :ref:`constant_linear_velocity` or :ref:`constant_angular_velocity` is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels. + +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. .. rst-class:: classref-introduction-group diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 0d7248c59..374e76af6 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StaticBody2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StaticBody2D.xml. .. _class_StaticBody2D: diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 8f625b4bd..6d729aa1c 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StreamPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StreamPeer.xml. .. _class_StreamPeer: diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 682700594..aec9a47e3 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StreamPeerBuffer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StreamPeerBuffer.xml. .. _class_StreamPeerBuffer: diff --git a/classes/class_streampeergdnative.rst b/classes/class_streampeergdnative.rst index 6c2871dd1..bf1c477d4 100644 --- a/classes/class_streampeergdnative.rst +++ b/classes/class_streampeergdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/StreamPeerGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/StreamPeerGDNative.xml. .. _class_StreamPeerGDNative: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 68c032260..4928a59e5 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StreamPeerSSL.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StreamPeerSSL.xml. .. _class_StreamPeerSSL: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index d184a6d10..d48e6a873 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StreamPeerTCP.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StreamPeerTCP.xml. .. _class_StreamPeerTCP: diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index b6712d176..1309bd71e 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StreamTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StreamTexture.xml. .. _class_StreamTexture: diff --git a/classes/class_string.rst b/classes/class_string.rst index daf18d219..60de2589a 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/String.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/String.xml. .. _class_String: @@ -805,7 +805,7 @@ If the string is a valid file path, returns the filename. :ref:`String` **get_slice** **(** :ref:`String` delimiter, :ref:`int` slice **)** -Splits a string using a ``delimiter`` and returns a substring at index ``slice``. Returns an empty string if the index doesn't exist. +Splits a string using a ``delimiter`` and returns a substring at index ``slice``. Returns the original string if ``delimiter`` does not occur in the string. Returns an empty string if the index doesn't exist. This is a more performant alternative to :ref:`split` for cases when you need only one element from the array at a fixed index. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 75c878fea..b3c94eb8c 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StyleBox.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StyleBox.xml. .. _class_StyleBox: diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 07f51c756..d0fdb306e 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StyleBoxEmpty.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StyleBoxEmpty.xml. .. _class_StyleBoxEmpty: diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 9edea2773..b71f59aab 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StyleBoxFlat.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StyleBoxFlat.xml. .. _class_StyleBoxFlat: diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 1403828ae..b4491a3fb 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StyleBoxLine.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StyleBoxLine.xml. .. _class_StyleBoxLine: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index d8724994a..ceee2ef0a 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/StyleBoxTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/StyleBoxTexture.xml. .. _class_StyleBoxTexture: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index b2e80908d..1078504c7 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/SurfaceTool.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SurfaceTool.xml. .. _class_SurfaceTool: @@ -131,7 +131,7 @@ void **add_color** **(** :ref:`Color` color **)** Specifies a :ref:`Color` to use for the *next* vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. -\ **Note:** The material must have :ref:`SpatialMaterial.vertex_color_use_as_albedo` enabled for the vertex color to be visible. +\ **Note:** The material must have :ref:`Material3D.vertex_color_use_as_albedo` enabled for the vertex color to be visible. .. rst-class:: classref-item-separator diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 4e2688c3f..3712424c4 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TabContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TabContainer.xml. .. _class_TabContainer: @@ -62,41 +62,45 @@ Methods .. table:: :widths: auto - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_current_tab_control` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Popup` | :ref:`get_popup` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_tab_hidden` **(** :ref:`int` tab_idx **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tab_idx_at_point` **(** :ref:`Vector2` point **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_hidden` **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | - +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_current_tab_control` **(** **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Popup` | :ref:`get_popup` **(** **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_previous_tab` **(** **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_count` **(** **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_tab_hidden` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tab_idx_at_point` **(** :ref:`Vector2` point **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_popup` **(** :ref:`Node` popup **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_hidden` **(** :ref:`int` tab_idx, :ref:`bool` hidden **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -452,6 +456,18 @@ Returns the index of the tab at local coordinates ``point``. Returns ``-1`` if t ---- +.. _class_TabContainer_method_get_tab_metadata: + +.. rst-class:: classref-method + +:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| + +Returns the metadata value set to the tab at index ``tab_idx``. If no metadata was previously set, returns ``null`` by default. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_get_tab_title: .. rst-class:: classref-method @@ -524,6 +540,18 @@ Sets an icon for the tab at index ``tab_idx``. ---- +.. _class_TabContainer_method_set_tab_metadata: + +.. rst-class:: classref-method + +void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** + +Sets the metadata value for the tab at index ``tab_idx``. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_method_set_tab_title: .. rst-class:: classref-method diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index fc424fc94..1dfca56fe 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Tabs.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Tabs.xml. .. _class_Tabs: @@ -68,6 +68,8 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_tab_metadata` **(** :ref:`int` tab_idx **)** |const| | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_offset` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** |const| | @@ -88,6 +90,8 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_tab_metadata` **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | @@ -512,6 +516,18 @@ Returns the :ref:`Texture` for the tab at index ``tab_idx`` or `` ---- +.. _class_Tabs_method_get_tab_metadata: + +.. rst-class:: classref-method + +:ref:`Variant` **get_tab_metadata** **(** :ref:`int` tab_idx **)** |const| + +Returns the metadata value set to the tab at index ``tab_idx``. If no metadata was previously set, returns ``null`` by default. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tabs_method_get_tab_offset: .. rst-class:: classref-method @@ -632,6 +648,18 @@ Sets an ``icon`` for the tab at index ``tab_idx``. ---- +.. _class_Tabs_method_set_tab_metadata: + +.. rst-class:: classref-method + +void **set_tab_metadata** **(** :ref:`int` tab_idx, :ref:`Variant` metadata **)** + +Sets the metadata value for the tab at index ``tab_idx``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tabs_method_set_tab_title: .. rst-class:: classref-method diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 25383351b..7428b9dc2 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TCP_Server.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TCP_Server.xml. .. _class_TCP_Server: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 7c9e299fd..2de2ad381 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextEdit.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextEdit.xml. .. _class_TextEdit: diff --git a/classes/class_textfile.rst b/classes/class_textfile.rst index 828f07096..efc091bc2 100644 --- a/classes/class_textfile.rst +++ b/classes/class_textfile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextFile.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextFile.xml. .. _class_TextFile: diff --git a/classes/class_textmesh.rst b/classes/class_textmesh.rst index df12f9cc5..167650108 100644 --- a/classes/class_textmesh.rst +++ b/classes/class_textmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextMesh.xml. .. _class_TextMesh: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 9f4662e01..9528fcbb3 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Texture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Texture.xml. .. _class_Texture: diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index d7a591502..beb2045ed 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Texture3D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Texture3D.xml. .. _class_Texture3D: diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst index 74b4a1bc4..3a4b3f206 100644 --- a/classes/class_texturearray.rst +++ b/classes/class_texturearray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextureArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextureArray.xml. .. _class_TextureArray: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index c17cbd2eb..f6a83d7c4 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextureButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextureButton.xml. .. _class_TextureButton: diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index fe3b50159..45ee21fbf 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextureLayered.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextureLayered.xml. .. _class_TextureLayered: diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 5760d90c1..efe5248f0 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextureProgress.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextureProgress.xml. .. _class_TextureProgress: diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 339bdc395..1d14a14d4 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TextureRect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextureRect.xml. .. _class_TextureRect: diff --git a/classes/class_theme.rst b/classes/class_theme.rst index e573398fc..060e78dd8 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Theme.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Theme.xml. .. _class_Theme: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index f0523550c..c0d93bfe9 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Thread.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Thread.xml. .. _class_Thread: @@ -23,6 +23,16 @@ A unit of execution in a process. Can run methods on :ref:`Object` \ **Note:** Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger. +\ **Warning:**\ + +To guarantee that the operating system is able to perform proper cleanup (no crashes, no deadlocks), these conditions must be met by the time a **Thread**'s reference count reaches zero and therefore it is destroyed: + +- It must not have any :ref:`Mutex` objects locked. + +- It must not be waiting on any :ref:`Semaphore` objects. + +- :ref:`wait_to_finish` should have been called on it. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 78a7cabae..a88f73fd9 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TileMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TileMap.xml. .. _class_TileMap: diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index a594ebffe..ff660a098 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TileSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TileSet.xml. .. _class_TileSet: @@ -63,6 +63,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FallbackMode` | :ref:`autotile_get_fallback_mode` **(** :ref:`int` id **)** |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`autotile_get_icon_coordinate` **(** :ref:`int` id **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OccluderPolygon2D` | :ref:`autotile_get_light_occluder` **(** :ref:`int` id, :ref:`Vector2` coord **)** |const| | @@ -81,6 +83,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`autotile_set_fallback_mode` **(** :ref:`int` id, :ref:`FallbackMode` mode **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_icon_coordinate` **(** :ref:`int` id, :ref:`Vector2` coord **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`autotile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder, :ref:`Vector2` coord **)** | @@ -227,6 +231,32 @@ enum **BitmaskMode**: +.. rst-class:: classref-item-separator + +---- + +.. _enum_TileSet_FallbackMode: + +.. rst-class:: classref-enumeration + +enum **FallbackMode**: + +.. _class_TileSet_constant_FALLBACK_AUTO: + +.. rst-class:: classref-enumeration-constant + +:ref:`FallbackMode` **FALLBACK_AUTO** = ``0`` + +Autotiles will automatically find a best match for missing tiles if they're incomplete. + +.. _class_TileSet_constant_FALLBACK_ICON: + +.. rst-class:: classref-enumeration-constant + +:ref:`FallbackMode` **FALLBACK_ICON** = ``1`` + +Autotiles will use the icon tile for missing tiles if they're incomplete. + .. rst-class:: classref-item-separator ---- @@ -432,6 +462,18 @@ Returns the :ref:`BitmaskMode` of the autotile. ---- +.. _class_TileSet_method_autotile_get_fallback_mode: + +.. rst-class:: classref-method + +:ref:`FallbackMode` **autotile_get_fallback_mode** **(** :ref:`int` id **)** |const| + +Returns the :ref:`FallbackMode` of the autotile. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileSet_method_autotile_get_icon_coordinate: .. rst-class:: classref-method @@ -546,6 +588,18 @@ Sets the :ref:`BitmaskMode` of the autotile. ---- +.. _class_TileSet_method_autotile_set_fallback_mode: + +.. rst-class:: classref-method + +void **autotile_set_fallback_mode** **(** :ref:`int` id, :ref:`FallbackMode` mode **)** + +Returns the :ref:`FallbackMode` of the autotile. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileSet_method_autotile_set_icon_coordinate: .. rst-class:: classref-method @@ -554,7 +608,7 @@ void **autotile_set_icon_coordinate** **(** :ref:`int` id, :ref:`Vect Sets the subtile that will be used as an icon in an atlas/autotile given its coordinates. -The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. +The subtile defined as the icon may be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. .. rst-class:: classref-item-separator diff --git a/classes/class_time.rst b/classes/class_time.rst index 6166dc7c2..18f73b583 100644 --- a/classes/class_time.rst +++ b/classes/class_time.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Time.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Time.xml. .. _class_Time: diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 04a3252e2..3041c2fdc 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Timer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Timer.xml. .. _class_Timer: @@ -21,6 +21,8 @@ Description Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode. +\ **Note:** Timers are affected by :ref:`Engine.time_scale`, a higher scale means quicker timeouts, and vice versa. + \ **Note:** To create a one-shot timer without instantiating a node, use :ref:`SceneTree.create_timer`. .. rst-class:: classref-introduction-group @@ -226,7 +228,7 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. The wait time in seconds. -\ **Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_mode` is :ref:`TIMER_PROCESS_PHYSICS`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. +\ **Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_mode` is :ref:`TIMER_PROCESS_PHYSICS`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. Timers are affected by :ref:`Engine.time_scale`, a higher scale means quicker timeouts, and vice versa. .. rst-class:: classref-section-separator diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index a5c2540d2..8cb4239ce 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ToolButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ToolButton.xml. .. _class_ToolButton: diff --git a/classes/class_torusmesh.rst b/classes/class_torusmesh.rst index a9416267d..a3b62ac44 100644 --- a/classes/class_torusmesh.rst +++ b/classes/class_torusmesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TorusMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TorusMesh.xml. .. _class_TorusMesh: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index c08ab1b8e..0e78ddd6f 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TouchScreenButton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TouchScreenButton.xml. .. _class_TouchScreenButton: diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 58e151605..0a7a4b99d 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Transform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Transform.xml. .. _class_Transform: diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 248381e98..98d7a8e4f 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Transform2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Transform2D.xml. .. _class_Transform2D: @@ -71,6 +71,8 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`determinant` **(** **)** | + +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_origin` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** | @@ -251,6 +253,20 @@ This method does not account for translation (the origin vector). ---- +.. _class_Transform2D_method_determinant: + +.. rst-class:: classref-method + +:ref:`float` **determinant** **(** **)** + +Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor. + +A negative determinant means the basis was flipped, so one part of the scale is negative. A zero determinant means the basis isn't invertible, and is usually considered invalid. + +.. rst-class:: classref-item-separator + +---- + .. _class_Transform2D_method_get_origin: .. rst-class:: classref-method diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 347bb7c68..8f9dd8e87 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Translation.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Translation.xml. .. _class_Translation: diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 2954573e9..14e2021a7 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TranslationServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TranslationServer.xml. .. _class_TranslationServer: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 3aea552db..ceaccff02 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Tree.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Tree.xml. .. _class_Tree: @@ -51,6 +51,8 @@ Properties +------------------------------------------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`allow_rmb_select` | ``false`` | +------------------------------------------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_search` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`column_titles_visible` | ``false`` | +------------------------------------------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`columns` | ``1`` | @@ -535,6 +537,23 @@ If ``true``, a right mouse button click can select items. ---- +.. _class_Tree_property_allow_search: + +.. rst-class:: classref-property + +:ref:`bool` **allow_search** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_allow_search** **(** :ref:`bool` value **)** +- :ref:`bool` **get_allow_search** **(** **)** + +If ``true``, allows navigating the **Tree** with letter keys through incremental search. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_property_column_titles_visible: .. rst-class:: classref-property diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 06e8b3e98..7be3256d6 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TreeItem.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TreeItem.xml. .. _class_TreeItem: @@ -23,6 +23,8 @@ Control for a single item inside a :ref:`Tree`. May have child **Tre You can remove a **TreeItem** by using :ref:`Object.free`. +\ **Note:** The ID values used for buttons are limited to 32 bits, not full 64 bits of :ref:`int`. This has a range of ``-2^32`` to ``2^32 - 1``, i.e. ``-2147483648`` to ``2147483647``. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 6183ee15c..5cc493c7f 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/TriangleMesh.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TriangleMesh.xml. .. _class_TriangleMesh: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 4315825ee..15d0589ce 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Tween.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Tween.xml. .. _class_Tween: @@ -37,7 +37,7 @@ Many methods require a property name, such as ``"position"`` above. You can find Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see `easings.net `__ for some examples). The second accepts an :ref:`EaseType` constant, and controls where the ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with :ref:`EASE_IN_OUT`, and use the one that looks best. -\ `Tween easing and transition types cheatsheet `__\ +\ `Tween easing and transition types cheatsheet `__\ \ **Note:** Tween methods will return ``false`` if the requested operation cannot be completed. diff --git a/classes/class_tweener.rst b/classes/class_tweener.rst index 886435ba7..bc00d7b56 100644 --- a/classes/class_tweener.rst +++ b/classes/class_tweener.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Tweener.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Tweener.xml. .. _class_Tweener: diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index 46b3abdba..89a5caed8 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/UDPServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/UDPServer.xml. .. _class_UDPServer: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index e043c13fd..738251c89 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/UndoRedo.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/UndoRedo.xml. .. _class_UndoRedo: diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 7d52555db..e026b284b 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/upnp/doc_classes/UPNP.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/upnp/doc_classes/UPNP.xml. .. _class_UPNP: diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index a0913ac20..71b9f9de4 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/upnp/doc_classes/UPNPDevice.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/upnp/doc_classes/UPNPDevice.xml. .. _class_UPNPDevice: diff --git a/classes/class_variant.rst b/classes/class_variant.rst index acaa927d3..80714c6b8 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Variant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Variant.xml. .. _class_Variant: diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 45b9728a6..60748aefd 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VBoxContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VBoxContainer.xml. .. _class_VBoxContainer: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 2555ecf93..4275689a6 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Vector2.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Vector2.xml. .. _class_Vector2: @@ -97,6 +97,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx` **(** **)** | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -315,7 +317,7 @@ Returns the angle to the given vector, in radians. Returns the angle between the line connecting the two points and the X axis, in radians. -\ `Illustration of the returned angle. `__ +\ `Illustration of the returned angle. `__ .. rst-class:: classref-item-separator @@ -379,7 +381,7 @@ Returns the vector with a maximum length by limiting its length to ``length``. Returns the 2D analog of the cross product for this vector and ``with``. -This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. +This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area. If the two vectors are parallel this returns zero, making it useful for testing if two vectors are parallel. \ **Note:** Cross product is not defined in 2D mathematically. This method embeds the 2D vectors in the XY plane of 3D space and uses their cross product's Z component as the analog. @@ -491,6 +493,20 @@ Returns ``true`` if the vector is normalized, ``false`` otherwise. ---- +.. _class_Vector2_method_is_zero_approx: + +.. rst-class:: classref-method + +:ref:`bool` **is_zero_approx** **(** **)** + +Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GDScript.is_zero_approx` on each component. + +This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector2_method_length: .. rst-class:: classref-method diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 771d957ae..8e25fcc9a 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Vector3.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Vector3.xml. .. _class_Vector3: @@ -93,6 +93,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_zero_approx` **(** **)** | + +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -359,6 +361,8 @@ Returns a new vector with all components rounded up (towards positive infinity). Returns the cross product of this vector and ``b``. +This returns a vector perpendicular to both this and ``b``, which would be the normal vector of the plane defined by the two vectors. As there are two such vectors, in opposite directions, this method returns the vector defined by a right-handed coordinate system. If the two vectors are parallel this returns an empty vector, making it useful for testing if two vectors are parallel. + .. rst-class:: classref-item-separator ---- @@ -479,6 +483,20 @@ Returns ``true`` if the vector is normalized, ``false`` otherwise. ---- +.. _class_Vector3_method_is_zero_approx: + +.. rst-class:: classref-method + +:ref:`bool` **is_zero_approx** **(** **)** + +Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GDScript.is_zero_approx` on each component. + +This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. + +.. rst-class:: classref-item-separator + +---- + .. _class_Vector3_method_length: .. rst-class:: classref-method diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index a4b4a9cb3..e00656489 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VehicleBody.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VehicleBody.xml. .. _class_VehicleBody: @@ -25,6 +25,8 @@ This node implements all the physics logic needed to simulate a car. It is based \ **Note:** This class has known issues and isn't designed to provide realistic 3D vehicle physics. If you want advanced vehicle physics, you will probably have to write your own physics integration using another :ref:`PhysicsBody` class. +\ **Warning:** With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index a0b255f50..acbde4315 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VehicleWheel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VehicleWheel.xml. .. _class_VehicleWheel: diff --git a/classes/class_vflowcontainer.rst b/classes/class_vflowcontainer.rst index 7da4fd875..4c6e4b9cf 100644 --- a/classes/class_vflowcontainer.rst +++ b/classes/class_vflowcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VFlowContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VFlowContainer.xml. .. _class_VFlowContainer: diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 2dccffc2d..a92f0f06b 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VideoPlayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VideoPlayer.xml. .. _class_VideoPlayer: @@ -46,6 +46,8 @@ Properties +---------------------------------------+--------------------------------------------------------------------+--------------+ | :ref:`bool` | :ref:`expand` | ``true`` | +---------------------------------------+--------------------------------------------------------------------+--------------+ + | :ref:`bool` | :ref:`loop` | ``false`` | + +---------------------------------------+--------------------------------------------------------------------+--------------+ | :ref:`bool` | :ref:`paused` | ``false`` | +---------------------------------------+--------------------------------------------------------------------+--------------+ | :ref:`VideoStream` | :ref:`stream` | | @@ -188,6 +190,23 @@ If ``true``, the video scales to the control size. Otherwise, the control minimu ---- +.. _class_VideoPlayer_property_loop: + +.. rst-class:: classref-property + +:ref:`bool` **loop** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_loop** **(** :ref:`bool` value **)** +- :ref:`bool` **has_loop** **(** **)** + +If ``true``, the video restarts when it reaches its end. + +.. rst-class:: classref-item-separator + +---- + .. _class_VideoPlayer_property_paused: .. rst-class:: classref-property diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index dca551b34..dea031fbc 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VideoStream.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VideoStream.xml. .. _class_VideoStream: diff --git a/classes/class_videostreamgdnative.rst b/classes/class_videostreamgdnative.rst index 4458edd09..d5f20058a 100644 --- a/classes/class_videostreamgdnative.rst +++ b/classes/class_videostreamgdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/VideoStreamGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/VideoStreamGDNative.xml. .. _class_VideoStreamGDNative: diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index aa51cdba2..b12c5d590 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/theora/doc_classes/VideoStreamTheora.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/theora/doc_classes/VideoStreamTheora.xml. .. _class_VideoStreamTheora: diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 35af2a3eb..6a389adee 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webm/doc_classes/VideoStreamWebm.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webm/doc_classes/VideoStreamWebm.xml. .. _class_VideoStreamWebm: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 8e023d10c..aa28890a4 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Viewport.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Viewport.xml. .. _class_Viewport: @@ -62,75 +62,77 @@ Properties .. table:: :widths: auto - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`arvr` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`audio_listener_enable_2d` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`audio_listener_enable_3d` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`Transform2D` | :ref:`canvas_transform` | | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`debanding` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`DebugDraw` | :ref:`debug_draw` | ``0`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`disable_3d` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`fxaa` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`Transform2D` | :ref:`global_canvas_transform` | | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`gui_disable_input` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | ``true`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`handle_input_locally` | ``true`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`hdr` | ``true`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`keep_3d_linear` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`MSAA` | :ref:`msaa` | ``0`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`own_world` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`physics_object_picking` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`render_direct_to_screen` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`ClearMode` | :ref:`render_target_clear_mode` | ``0`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`UpdateMode` | :ref:`render_target_update_mode` | ``2`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`render_target_v_flip` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | ``2`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | ``2`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | ``3`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | ``4`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`int` | :ref:`shadow_atlas_size` | ``0`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`float` | :ref:`sharpen_intensity` | ``0.0`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`Vector2` | :ref:`size` | ``Vector2( 0, 0 )`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`size_override_stretch` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`transparent_bg` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`Usage` | :ref:`usage` | ``2`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`bool` | :ref:`use_32_bpc_depth` | ``false`` | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`World` | :ref:`world` | | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ - | :ref:`World2D` | :ref:`world_2d` | | - +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`arvr` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio_listener_enable_2d` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`audio_listener_enable_3d` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`canvas_transform` | | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debanding` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`DebugDraw` | :ref:`debug_draw` | ``0`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`disable_3d` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`fxaa` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Transform2D` | :ref:`global_canvas_transform` | | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui_disable_input` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`gui_snap_controls_to_pixels` | ``true`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`handle_input_locally` | ``true`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`hdr` | ``true`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`keep_3d_linear` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`MSAA` | :ref:`msaa` | ``0`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`own_world` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`physics_object_picking` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`render_direct_to_screen` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`ClearMode` | :ref:`render_target_clear_mode` | ``0`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`UpdateMode` | :ref:`render_target_update_mode` | ``2`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`render_target_v_flip` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_0` | ``2`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_1` | ``2`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_2` | ``3`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`ShadowAtlasQuadrantSubdiv` | :ref:`shadow_atlas_quad_3` | ``4`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shadow_atlas_size` | ``0`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`sharpen_intensity` | ``0.0`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`size` | ``Vector2( 0, 0 )`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`size_override_stretch` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`transparent_bg` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`Usage` | :ref:`usage` | ``2`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_32_bpc_depth` | ``false`` | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`World` | :ref:`world` | | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`World2D` | :ref:`world_2d` | | + +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index a6f2fda44..96a243a3c 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ViewportContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ViewportContainer.xml. .. _class_ViewportContainer: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 03ba8d778..b672fc531 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ViewportTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ViewportTexture.xml. .. _class_ViewportTexture: diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 4e9b2a208..82b1a7a4c 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisibilityEnabler.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisibilityEnabler.xml. .. _class_VisibilityEnabler: diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 6a4e8507f..48cd77fd5 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisibilityEnabler2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisibilityEnabler2D.xml. .. _class_VisibilityEnabler2D: diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 720999d29..5077ae836 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisibilityNotifier.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisibilityNotifier.xml. .. _class_VisibilityNotifier: diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index eb958c60f..62cb53e32 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisibilityNotifier2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisibilityNotifier2D.xml. .. _class_VisibilityNotifier2D: diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 411279f6b..f745e39ba 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualInstance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualInstance.xml. .. _class_VisualInstance: diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 9d037e5de..bd7723e8b 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScript.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScript.xml. .. _class_VisualScript: diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 212109d80..3dc5b01de 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml. .. _class_VisualScriptBasicTypeConstant: diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 1841017ec..259e1b64b 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml. .. _class_VisualScriptBuiltinFunc: diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 81439c21a..35bab92c7 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptClassConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptClassConstant.xml. .. _class_VisualScriptClassConstant: diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index aa646070f..e0927e115 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptComment.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptComment.xml. .. _class_VisualScriptComment: diff --git a/classes/class_visualscriptcomposearray.rst b/classes/class_visualscriptcomposearray.rst index 9e892f4e4..c65e055f8 100644 --- a/classes/class_visualscriptcomposearray.rst +++ b/classes/class_visualscriptcomposearray.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptComposeArray.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptComposeArray.xml. .. _class_VisualScriptComposeArray: diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index 0b900fea9..285a17b38 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptCondition.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptCondition.xml. .. _class_VisualScriptCondition: diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 8d2446944..f15d63eb1 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptConstant.xml. .. _class_VisualScriptConstant: diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index f942ff4fe..534d9a330 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptConstructor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptConstructor.xml. .. _class_VisualScriptConstructor: diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index f8bd4e72e..ee234d8e4 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptCustomNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptCustomNode.xml. .. _class_VisualScriptCustomNode: diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 85f9998f4..a0e03a209 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml. .. _class_VisualScriptDeconstruct: diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index 64f686dcb..3a11dfb04 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptEditor.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptEditor.xml. .. _class_VisualScriptEditor: diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 8c2c8c178..67932d1f5 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml. .. _class_VisualScriptEmitSignal: diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 401e5bac2..bfa7ab782 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml. .. _class_VisualScriptEngineSingleton: diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst index 12fd053c7..fd0482d4d 100644 --- a/classes/class_visualscriptexpression.rst +++ b/classes/class_visualscriptexpression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptExpression.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptExpression.xml. .. _class_VisualScriptExpression: diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst index 03b429115..b4804b5f9 100644 --- a/classes/class_visualscriptfunction.rst +++ b/classes/class_visualscriptfunction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptFunction.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptFunction.xml. .. _class_VisualScriptFunction: diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 68ef8d26a..534c7d17c 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml. .. _class_VisualScriptFunctionCall: diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index bef2bee1c..93dd5fe46 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptFunctionState.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptFunctionState.xml. .. _class_VisualScriptFunctionState: diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index d88147c2c..8be432b8a 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml. .. _class_VisualScriptGlobalConstant: diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index 593145f96..f6043ad07 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptIndexGet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptIndexGet.xml. .. _class_VisualScriptIndexGet: diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 834fab2f9..58dfe7e6f 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptIndexSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptIndexSet.xml. .. _class_VisualScriptIndexSet: diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index a42c4ce7f..4be72fc40 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptInputAction.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptInputAction.xml. .. _class_VisualScriptInputAction: diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index c0b6fef57..b6b23aa83 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptIterator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptIterator.xml. .. _class_VisualScriptIterator: diff --git a/classes/class_visualscriptlists.rst b/classes/class_visualscriptlists.rst index a1c3504c3..fba6beb59 100644 --- a/classes/class_visualscriptlists.rst +++ b/classes/class_visualscriptlists.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptLists.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptLists.xml. .. _class_VisualScriptLists: diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index ab1edc932..638b4b355 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptLocalVar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptLocalVar.xml. .. _class_VisualScriptLocalVar: diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 58683cffd..050bac2b7 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml. .. _class_VisualScriptLocalVarSet: diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 1a1f9d4e5..47bea6fd5 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptMathConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptMathConstant.xml. .. _class_VisualScriptMathConstant: diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 8754a5edf..ae5038f64 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptNode.xml. .. _class_VisualScriptNode: diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index b9551bb61..330ecbdea 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptOperator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptOperator.xml. .. _class_VisualScriptOperator: diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 04d5fd811..4b4873489 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptPreload.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptPreload.xml. .. _class_VisualScriptPreload: diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index b6548ad21..56d527351 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml. .. _class_VisualScriptPropertyGet: diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 8165ba131..31c913363 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptPropertySet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptPropertySet.xml. .. _class_VisualScriptPropertySet: diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index e31c1b589..5fdcc36fe 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptResourcePath.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptResourcePath.xml. .. _class_VisualScriptResourcePath: diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 2929a124e..b94bc8f1a 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptReturn.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptReturn.xml. .. _class_VisualScriptReturn: diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 770657086..53d48841d 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSceneNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSceneNode.xml. .. _class_VisualScriptSceneNode: diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 5c9519a74..28a10104a 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSceneTree.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSceneTree.xml. .. _class_VisualScriptSceneTree: diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index b61578b72..655313481 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSelect.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSelect.xml. .. _class_VisualScriptSelect: diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 5a533de40..29f998656 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSelf.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSelf.xml. .. _class_VisualScriptSelf: diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index b96985f54..30d96434f 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSequence.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSequence.xml. .. _class_VisualScriptSequence: diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index 21b158ea1..7e82afe80 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSubCall.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSubCall.xml. .. _class_VisualScriptSubCall: diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index b9069a862..8b68b547b 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptSwitch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptSwitch.xml. .. _class_VisualScriptSwitch: diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 7e2842c1d..141659cba 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptTypeCast.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptTypeCast.xml. .. _class_VisualScriptTypeCast: diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 2927ce653..f93f23677 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptVariableGet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptVariableGet.xml. .. _class_VisualScriptVariableGet: diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 1ab681f02..877511fba 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptVariableSet.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptVariableSet.xml. .. _class_VisualScriptVariableSet: diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index a60d887f9..f4a95b506 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptWhile.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptWhile.xml. .. _class_VisualScriptWhile: diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 7ef2d847e..5d5e8271f 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptYield.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptYield.xml. .. _class_VisualScriptYield: diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 2eb2d6719..2eb45da5e 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml. .. _class_VisualScriptYieldSignal: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 36a64b066..9a0ac779e 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualServer.xml. .. _class_VisualServer: @@ -71,16 +71,12 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`camera_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_reset_physics_interpolation` **(** :ref:`RID` camera **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`camera_set_interpolated` **(** :ref:`RID` camera, :ref:`bool` interpolated **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | @@ -125,6 +121,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_item_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_item_reset_physics_interpolation` **(** :ref:`RID` item **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | @@ -137,6 +135,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_item_set_interpolated` **(** :ref:`RID` item, :ref:`bool` interpolated **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | @@ -159,6 +159,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_item_transform_physics_interpolation` **(** :ref:`RID` item, :ref:`Transform2D` xform **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_create` **(** **)** | @@ -167,14 +169,22 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_occluder_reset_physics_interpolation` **(** :ref:`RID` occluder **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_occluder_set_interpolated` **(** :ref:`RID` occluder, :ref:`bool` interpolated **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_occluder_transform_physics_interpolation` **(** :ref:`RID` occluder, :ref:`Transform2D` xform **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_reset_physics_interpolation` **(** :ref:`RID` light **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | @@ -183,6 +193,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_set_interpolated` **(** :ref:`RID` light, :ref:`bool` interpolated **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | @@ -213,6 +225,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`canvas_light_transform_physics_interpolation` **(** :ref:`RID` light, :ref:`Transform2D` xform **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | @@ -225,6 +239,10 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`debug_canvas_item_get_local_bound` **(** :ref:`RID` item **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`debug_canvas_item_get_rect` **(** :ref:`RID` item **)** | + +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`directional_light_create` **(** **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | @@ -375,12 +393,8 @@ Methods +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | - +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | +---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_material_overlay` **(** :ref:`RID` instance, :ref:`RID` material **)** | @@ -1636,11 +1650,19 @@ Bias the shadow lookup to fix self-shadowing artifacts. Increases bias on further splits to fix self-shadowing that only occurs far away from the camera. +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_FADE_START: + +.. rst-class:: classref-enumeration-constant + +:ref:`LightParam` **LIGHT_PARAM_SHADOW_FADE_START** = ``16`` + +Proportion of :ref:`LIGHT_PARAM_SHADOW_MAX_DISTANCE` at which point the shadow starts to fade. At :ref:`LIGHT_PARAM_SHADOW_MAX_DISTANCE`, the shadow will disappear. The default value is a balance between smooth fading and distant shadow visibility. If the camera moves fast and the :ref:`LIGHT_PARAM_SHADOW_MAX_DISTANCE` is low, consider lowering :ref:`LIGHT_PARAM_SHADOW_FADE_START` below ``0.8`` to make shadow transitions less noticeable. On the other hand, if you tuned :ref:`LIGHT_PARAM_SHADOW_MAX_DISTANCE` to cover the entire scene, you can set :ref:`LIGHT_PARAM_SHADOW_FADE_START` to ``1.0`` to prevent the shadow from fading in the distance (it will suddenly cut off instead). + .. _class_VisualServer_constant_LIGHT_PARAM_MAX: .. rst-class:: classref-enumeration-constant -:ref:`LightParam` **LIGHT_PARAM_MAX** = ``16`` +:ref:`LightParam` **LIGHT_PARAM_MAX** = ``17`` Represents the size of the :ref:`LightParam` enum. @@ -1756,11 +1778,19 @@ Use orthogonal shadow projection for directional light. Use 2 splits for shadow projection when using directional light. +.. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_3_SPLITS: + +.. rst-class:: classref-enumeration-constant + +:ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_3_SPLITS** = ``2`` + +Use 3 splits for shadow projection when using directional light. + .. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS: .. rst-class:: classref-enumeration-constant -:ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2`` +:ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``3`` Use 4 splits for shadow projection when using directional light. @@ -3254,20 +3284,6 @@ Once finished with your RID, you will want to free the RID using the VisualServe ---- -.. _class_VisualServer_method_camera_reset_physics_interpolation: - -.. rst-class:: classref-method - -void **camera_reset_physics_interpolation** **(** :ref:`RID` camera **)** - -Prevents physics interpolation for the current physics tick. - -This is useful when moving a :ref:`Camera` to a new location, to give an instantaneous change rather than interpolation from the previous location. - -.. rst-class:: classref-item-separator - ----- - .. _class_VisualServer_method_camera_set_cull_mask: .. rst-class:: classref-method @@ -3304,18 +3320,6 @@ Sets camera to use frustum projection. This mode allows adjusting the ``offset`` ---- -.. _class_VisualServer_method_camera_set_interpolated: - -.. rst-class:: classref-method - -void **camera_set_interpolated** **(** :ref:`RID` camera, :ref:`bool` interpolated **)** - -Turns on and off physics interpolation for the :ref:`Camera`. - -.. rst-class:: classref-item-separator - ----- - .. _class_VisualServer_method_camera_set_orthogonal: .. rst-class:: classref-method @@ -3588,6 +3592,20 @@ Once finished with your RID, you will want to free the RID using the VisualServe ---- +.. _class_VisualServer_method_canvas_item_reset_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_item_reset_physics_interpolation** **(** :ref:`RID` item **)** + +Prevents physics interpolation for the current physics tick. + +This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_item_set_clip: .. rst-class:: classref-method @@ -3660,6 +3678,18 @@ Sets the index for the :ref:`CanvasItem`. ---- +.. _class_VisualServer_method_canvas_item_set_interpolated: + +.. rst-class:: classref-method + +void **canvas_item_set_interpolated** **(** :ref:`RID` item, :ref:`bool` interpolated **)** + +Turns on and off physics interpolation for the canvas item. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_item_set_light_mask: .. rst-class:: classref-method @@ -3792,6 +3822,22 @@ Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (low ---- +.. _class_VisualServer_method_canvas_item_transform_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_item_transform_physics_interpolation** **(** :ref:`RID` item, :ref:`Transform2D` xform **)** + +Transforms both the current and previous stored transform for a canvas item. + +This allows transforming a canvas item without creating a "glitch" in the interpolation. + +This is particularly useful for large worlds utilising a shifting origin. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_light_attach_to_canvas: .. rst-class:: classref-method @@ -3844,6 +3890,20 @@ Once finished with your RID, you will want to free the RID using the VisualServe ---- +.. _class_VisualServer_method_canvas_light_occluder_reset_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_light_occluder_reset_physics_interpolation** **(** :ref:`RID` occluder **)** + +Prevents physics interpolation for the current physics tick. + +This is useful when moving an occluder to a new location, to give an instantaneous change rather than interpolation from the previous location. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_light_occluder_set_enabled: .. rst-class:: classref-method @@ -3856,6 +3916,18 @@ Enables or disables light occluder. ---- +.. _class_VisualServer_method_canvas_light_occluder_set_interpolated: + +.. rst-class:: classref-method + +void **canvas_light_occluder_set_interpolated** **(** :ref:`RID` occluder, :ref:`bool` interpolated **)** + +Turns on and off physics interpolation for the occluder. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_light_occluder_set_light_mask: .. rst-class:: classref-method @@ -3892,6 +3964,36 @@ Sets a light occluder's :ref:`Transform2D`. ---- +.. _class_VisualServer_method_canvas_light_occluder_transform_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_light_occluder_transform_physics_interpolation** **(** :ref:`RID` occluder, :ref:`Transform2D` xform **)** + +Transforms both the current and previous stored transform for an occluder. + +This allows transforming an occluder without creating a "glitch" in the interpolation. + +This is particularly useful for large worlds utilising a shifting origin. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualServer_method_canvas_light_reset_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_light_reset_physics_interpolation** **(** :ref:`RID` light **)** + +Prevents physics interpolation for the current physics tick. + +This is useful when moving a light to a new location, to give an instantaneous change rather than interpolation from the previous location. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_light_set_color: .. rst-class:: classref-method @@ -3940,6 +4042,18 @@ Sets a canvas light's height. ---- +.. _class_VisualServer_method_canvas_light_set_interpolated: + +.. rst-class:: classref-method + +void **canvas_light_set_interpolated** **(** :ref:`RID` light, :ref:`bool` interpolated **)** + +Turns on and off physics interpolation for the light. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_light_set_item_cull_mask: .. rst-class:: classref-method @@ -4120,6 +4234,22 @@ Sets the Z range of objects that will be affected by this light. Equivalent to : ---- +.. _class_VisualServer_method_canvas_light_transform_physics_interpolation: + +.. rst-class:: classref-method + +void **canvas_light_transform_physics_interpolation** **(** :ref:`RID` light, :ref:`Transform2D` xform **)** + +Transforms both the current and previous stored transform for a light. + +This allows transforming a light without creating a "glitch" in the interpolation. + +This is particularly useful for large worlds utilising a shifting origin. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_canvas_occluder_polygon_create: .. rst-class:: classref-method @@ -4194,6 +4324,34 @@ Modulates all colors in the given canvas. ---- +.. _class_VisualServer_method_debug_canvas_item_get_local_bound: + +.. rst-class:: classref-method + +:ref:`Rect2` **debug_canvas_item_get_local_bound** **(** :ref:`RID` item **)** + +Returns the bounding rectangle for a canvas item and its descendants in local space, as calculated by the renderer. This bound is used internally for culling. + +\ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2` in exported projects. + +.. rst-class:: classref-item-separator + +---- + +.. _class_VisualServer_method_debug_canvas_item_get_rect: + +.. rst-class:: classref-method + +:ref:`Rect2` **debug_canvas_item_get_rect** **(** :ref:`RID` item **)** + +Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling. + +\ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2` in exported projects. + +.. rst-class:: classref-item-separator + +---- + .. _class_VisualServer_method_directional_light_create: .. rst-class:: classref-method @@ -5136,18 +5294,6 @@ Once finished with your RID, you will want to free the RID using the VisualServe ---- -.. _class_VisualServer_method_instance_geometry_set_as_instance_lod: - -.. rst-class:: classref-method - -void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** - -Not implemented in Godot 3.x. - -.. rst-class:: classref-item-separator - ----- - .. _class_VisualServer_method_instance_geometry_set_cast_shadows_setting: .. rst-class:: classref-method @@ -5160,18 +5306,6 @@ Sets the shadow casting setting to one of :ref:`ShadowCastingSetting` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** - -Not implemented in Godot 3.x. - -.. rst-class:: classref-item-separator - ----- - .. _class_VisualServer_method_instance_geometry_set_flag: .. rst-class:: classref-method @@ -7036,7 +7170,7 @@ Sets the default clear color which is used when a specific clear color has not b void **set_shader_async_hidden_forbidden** **(** :ref:`bool` forbidden **)** -If asynchronous shader compilation is enabled, this controls whether :ref:`SpatialMaterial.ASYNC_MODE_HIDDEN` is obeyed. +If asynchronous shader compilation is enabled, this controls whether :ref:`Material3D.ASYNC_MODE_HIDDEN` is obeyed. For instance, you may want to enable this temporarily before taking a screenshot. This ensures everything is visible even if shaders with async mode *hidden* are not ready yet. diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index cb17179c5..7f7e21a10 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShader.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShader.xml. .. _class_VisualShader: diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 515ed319f..5bff1cebc 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNode.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNode.xml. .. _class_VisualShaderNode: diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst index 88ee7bde0..837714824 100644 --- a/classes/class_visualshadernodebooleanconstant.rst +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeBooleanConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeBooleanConstant.xml. .. _class_VisualShaderNodeBooleanConstant: diff --git a/classes/class_visualshadernodebooleanuniform.rst b/classes/class_visualshadernodebooleanuniform.rst index 88c7db945..73f4f57a8 100644 --- a/classes/class_visualshadernodebooleanuniform.rst +++ b/classes/class_visualshadernodebooleanuniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeBooleanUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeBooleanUniform.xml. .. _class_VisualShaderNodeBooleanUniform: diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index eb95def0b..63ac7da24 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeColorConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeColorConstant.xml. .. _class_VisualShaderNodeColorConstant: diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst index 961eef947..58577ed0a 100644 --- a/classes/class_visualshadernodecolorfunc.rst +++ b/classes/class_visualshadernodecolorfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeColorFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeColorFunc.xml. .. _class_VisualShaderNodeColorFunc: diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index bf48aba5c..97607f17c 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeColorOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeColorOp.xml. .. _class_VisualShaderNodeColorOp: diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst index 22acec697..707dd5c77 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecoloruniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeColorUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeColorUniform.xml. .. _class_VisualShaderNodeColorUniform: diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index e855becd7..c63913dde 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeCompare.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeCompare.xml. .. _class_VisualShaderNodeCompare: diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 5ebe1cab5..2f2ae5208 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeCubeMap.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeCubeMap.xml. .. _class_VisualShaderNodeCubeMap: diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index 86ea812d0..892466bc9 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeCubeMapUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeCubeMapUniform.xml. .. _class_VisualShaderNodeCubeMapUniform: diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index b9c3eabf1..f5d7591d9 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeCustom.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeCustom.xml. .. _class_VisualShaderNodeCustom: diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst index 6b370cd28..88d516dfe 100644 --- a/classes/class_visualshadernodedeterminant.rst +++ b/classes/class_visualshadernodedeterminant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeDeterminant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeDeterminant.xml. .. _class_VisualShaderNodeDeterminant: diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index 3b9803d17..dde0381e1 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeDotProduct.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeDotProduct.xml. .. _class_VisualShaderNodeDotProduct: diff --git a/classes/class_visualshadernodeexpression.rst b/classes/class_visualshadernodeexpression.rst index 39e3bf45a..1449dd7c8 100644 --- a/classes/class_visualshadernodeexpression.rst +++ b/classes/class_visualshadernodeexpression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeExpression.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeExpression.xml. .. _class_VisualShaderNodeExpression: diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst index ec7f89fd8..6c83d53a6 100644 --- a/classes/class_visualshadernodefaceforward.rst +++ b/classes/class_visualshadernodefaceforward.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeFaceForward.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeFaceForward.xml. .. _class_VisualShaderNodeFaceForward: diff --git a/classes/class_visualshadernodefresnel.rst b/classes/class_visualshadernodefresnel.rst index fa3b52121..02e98738d 100644 --- a/classes/class_visualshadernodefresnel.rst +++ b/classes/class_visualshadernodefresnel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeFresnel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeFresnel.xml. .. _class_VisualShaderNodeFresnel: diff --git a/classes/class_visualshadernodeglobalexpression.rst b/classes/class_visualshadernodeglobalexpression.rst index cb1f5d63c..b6eb757d2 100644 --- a/classes/class_visualshadernodeglobalexpression.rst +++ b/classes/class_visualshadernodeglobalexpression.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeGlobalExpression.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeGlobalExpression.xml. .. _class_VisualShaderNodeGlobalExpression: diff --git a/classes/class_visualshadernodegroupbase.rst b/classes/class_visualshadernodegroupbase.rst index a16c2b6de..c79a74b8b 100644 --- a/classes/class_visualshadernodegroupbase.rst +++ b/classes/class_visualshadernodegroupbase.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeGroupBase.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeGroupBase.xml. .. _class_VisualShaderNodeGroupBase: diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 778906b17..10de20cfd 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeIf.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeIf.xml. .. _class_VisualShaderNodeIf: diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index a2eaaecef..3a8872b87 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeInput.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeInput.xml. .. _class_VisualShaderNodeInput: diff --git a/classes/class_visualshadernodeis.rst b/classes/class_visualshadernodeis.rst index 3e08731d8..3a11c2c23 100644 --- a/classes/class_visualshadernodeis.rst +++ b/classes/class_visualshadernodeis.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeIs.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeIs.xml. .. _class_VisualShaderNodeIs: diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst index b9f891b76..ac3cb218d 100644 --- a/classes/class_visualshadernodeouterproduct.rst +++ b/classes/class_visualshadernodeouterproduct.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeOuterProduct.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeOuterProduct.xml. .. _class_VisualShaderNodeOuterProduct: diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index 1c591142a..052b90d31 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeOutput.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeOutput.xml. .. _class_VisualShaderNodeOutput: diff --git a/classes/class_visualshadernodescalarclamp.rst b/classes/class_visualshadernodescalarclamp.rst index 632e8a933..75c3acff6 100644 --- a/classes/class_visualshadernodescalarclamp.rst +++ b/classes/class_visualshadernodescalarclamp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarClamp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarClamp.xml. .. _class_VisualShaderNodeScalarClamp: diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index a96d3212c..e0934db77 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarConstant.xml. .. _class_VisualShaderNodeScalarConstant: diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst index 1e0954698..f446e5322 100644 --- a/classes/class_visualshadernodescalarderivativefunc.rst +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml. .. _class_VisualShaderNodeScalarDerivativeFunc: diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index abb56939a..be6f15cbc 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarFunc.xml. .. _class_VisualShaderNodeScalarFunc: diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst index 0da6e6f57..d7abc0db2 100644 --- a/classes/class_visualshadernodescalarinterp.rst +++ b/classes/class_visualshadernodescalarinterp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarInterp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarInterp.xml. .. _class_VisualShaderNodeScalarInterp: diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index e02921904..09abeb2d3 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarOp.xml. .. _class_VisualShaderNodeScalarOp: diff --git a/classes/class_visualshadernodescalarsmoothstep.rst b/classes/class_visualshadernodescalarsmoothstep.rst index 93986ba41..75f0dae05 100644 --- a/classes/class_visualshadernodescalarsmoothstep.rst +++ b/classes/class_visualshadernodescalarsmoothstep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarSmoothStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarSmoothStep.xml. .. _class_VisualShaderNodeScalarSmoothStep: diff --git a/classes/class_visualshadernodescalarswitch.rst b/classes/class_visualshadernodescalarswitch.rst index cc83773ed..507ce62d8 100644 --- a/classes/class_visualshadernodescalarswitch.rst +++ b/classes/class_visualshadernodescalarswitch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarSwitch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarSwitch.xml. .. _class_VisualShaderNodeScalarSwitch: diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst index bfdde427e..f595ad7da 100644 --- a/classes/class_visualshadernodescalaruniform.rst +++ b/classes/class_visualshadernodescalaruniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeScalarUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeScalarUniform.xml. .. _class_VisualShaderNodeScalarUniform: diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst index 846493d81..5e6c0a1d7 100644 --- a/classes/class_visualshadernodeswitch.rst +++ b/classes/class_visualshadernodeswitch.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeSwitch.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeSwitch.xml. .. _class_VisualShaderNodeSwitch: diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 15de8a6e9..a7c5fdfd3 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTexture.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTexture.xml. .. _class_VisualShaderNodeTexture: diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index adb8a4a77..9bdf25166 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTextureUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTextureUniform.xml. .. _class_VisualShaderNodeTextureUniform: diff --git a/classes/class_visualshadernodetextureuniformtriplanar.rst b/classes/class_visualshadernodetextureuniformtriplanar.rst index d94111739..0686be17a 100644 --- a/classes/class_visualshadernodetextureuniformtriplanar.rst +++ b/classes/class_visualshadernodetextureuniformtriplanar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTextureUniformTriplanar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTextureUniformTriplanar.xml. .. _class_VisualShaderNodeTextureUniformTriplanar: diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index b847c8e36..3e82aa9d1 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformCompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformCompose.xml. .. _class_VisualShaderNodeTransformCompose: diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 381fb95db..997992edf 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformConstant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformConstant.xml. .. _class_VisualShaderNodeTransformConstant: diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 3b99fd685..b75d8398b 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformDecompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformDecompose.xml. .. _class_VisualShaderNodeTransformDecompose: diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst index c258239e8..7ef07c0a7 100644 --- a/classes/class_visualshadernodetransformfunc.rst +++ b/classes/class_visualshadernodetransformfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformFunc.xml. .. _class_VisualShaderNodeTransformFunc: diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 20c03d9fc..363cd9fcc 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformMult.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformMult.xml. .. _class_VisualShaderNodeTransformMult: diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst index 6b2808b26..acec8dc38 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformuniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformUniform.xml. .. _class_VisualShaderNodeTransformUniform: diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 761efa751..5c24b956d 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformVecMult.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformVecMult.xml. .. _class_VisualShaderNodeTransformVecMult: diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index deb5292b0..7cfb062f1 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeUniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeUniform.xml. .. _class_VisualShaderNodeUniform: diff --git a/classes/class_visualshadernodeuniformref.rst b/classes/class_visualshadernodeuniformref.rst index cb11e3e69..3628dfe75 100644 --- a/classes/class_visualshadernodeuniformref.rst +++ b/classes/class_visualshadernodeuniformref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeUniformRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeUniformRef.xml. .. _class_VisualShaderNodeUniformRef: diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index b6200a31d..4df0c150b 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVec3Constant.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVec3Constant.xml. .. _class_VisualShaderNodeVec3Constant: diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst index c0ec85e6f..0bec69b96 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3uniform.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVec3Uniform.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVec3Uniform.xml. .. _class_VisualShaderNodeVec3Uniform: diff --git a/classes/class_visualshadernodevectorclamp.rst b/classes/class_visualshadernodevectorclamp.rst index 5e7c06572..d6c5e9412 100644 --- a/classes/class_visualshadernodevectorclamp.rst +++ b/classes/class_visualshadernodevectorclamp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorClamp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorClamp.xml. .. _class_VisualShaderNodeVectorClamp: diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index c5bd6b53d..5493b1522 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorCompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorCompose.xml. .. _class_VisualShaderNodeVectorCompose: diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 7939d97f4..c1e4b233a 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorDecompose.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorDecompose.xml. .. _class_VisualShaderNodeVectorDecompose: diff --git a/classes/class_visualshadernodevectorderivativefunc.rst b/classes/class_visualshadernodevectorderivativefunc.rst index c87c3e65e..e4ff6d6d8 100644 --- a/classes/class_visualshadernodevectorderivativefunc.rst +++ b/classes/class_visualshadernodevectorderivativefunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml. .. _class_VisualShaderNodeVectorDerivativeFunc: diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst index df9645bf3..8ce769fd1 100644 --- a/classes/class_visualshadernodevectordistance.rst +++ b/classes/class_visualshadernodevectordistance.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorDistance.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorDistance.xml. .. _class_VisualShaderNodeVectorDistance: diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 6f8c98674..93d03b59a 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorFunc.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorFunc.xml. .. _class_VisualShaderNodeVectorFunc: diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst index b5b20bd5c..f6e229414 100644 --- a/classes/class_visualshadernodevectorinterp.rst +++ b/classes/class_visualshadernodevectorinterp.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorInterp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorInterp.xml. .. _class_VisualShaderNodeVectorInterp: diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index 921b48f61..f76788bd0 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorLen.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorLen.xml. .. _class_VisualShaderNodeVectorLen: diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 0311af6b7..42b9644c2 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorOp.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorOp.xml. .. _class_VisualShaderNodeVectorOp: diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst index 5a5fcaa2d..c83d7c08f 100644 --- a/classes/class_visualshadernodevectorrefract.rst +++ b/classes/class_visualshadernodevectorrefract.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorRefract.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorRefract.xml. .. _class_VisualShaderNodeVectorRefract: diff --git a/classes/class_visualshadernodevectorscalarmix.rst b/classes/class_visualshadernodevectorscalarmix.rst index b3d9a3702..b487f56c4 100644 --- a/classes/class_visualshadernodevectorscalarmix.rst +++ b/classes/class_visualshadernodevectorscalarmix.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorScalarMix.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorScalarMix.xml. .. _class_VisualShaderNodeVectorScalarMix: diff --git a/classes/class_visualshadernodevectorscalarsmoothstep.rst b/classes/class_visualshadernodevectorscalarsmoothstep.rst index 9db13c4ef..59b483116 100644 --- a/classes/class_visualshadernodevectorscalarsmoothstep.rst +++ b/classes/class_visualshadernodevectorscalarsmoothstep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorScalarSmoothStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorScalarSmoothStep.xml. .. _class_VisualShaderNodeVectorScalarSmoothStep: diff --git a/classes/class_visualshadernodevectorscalarstep.rst b/classes/class_visualshadernodevectorscalarstep.rst index e00dabb61..fa7db20d3 100644 --- a/classes/class_visualshadernodevectorscalarstep.rst +++ b/classes/class_visualshadernodevectorscalarstep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorScalarStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorScalarStep.xml. .. _class_VisualShaderNodeVectorScalarStep: diff --git a/classes/class_visualshadernodevectorsmoothstep.rst b/classes/class_visualshadernodevectorsmoothstep.rst index 5cc9c57a2..e590fa42a 100644 --- a/classes/class_visualshadernodevectorsmoothstep.rst +++ b/classes/class_visualshadernodevectorsmoothstep.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeVectorSmoothStep.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeVectorSmoothStep.xml. .. _class_VisualShaderNodeVectorSmoothStep: diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 7654e034e..dcb34dd61 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VScrollBar.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VScrollBar.xml. .. _class_VScrollBar: diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 878bb6e2a..4d31a64a1 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VSeparator.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VSeparator.xml. .. _class_VSeparator: diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index f0ebbbac9..e18e28e2e 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VSlider.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VSlider.xml. .. _class_VSlider: diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index d94056e8c..a8e571f11 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VSplitContainer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VSplitContainer.xml. .. _class_VSplitContainer: diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 0587de46d..6f437adb6 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/WeakRef.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/WeakRef.xml. .. _class_WeakRef: diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index 60f0fae8e..2964033b3 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webrtc/doc_classes/WebRTCDataChannel.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webrtc/doc_classes/WebRTCDataChannel.xml. .. _class_WebRTCDataChannel: diff --git a/classes/class_webrtcdatachannelgdnative.rst b/classes/class_webrtcdatachannelgdnative.rst index b2e9d07e2..07605c3b3 100644 --- a/classes/class_webrtcdatachannelgdnative.rst +++ b/classes/class_webrtcdatachannelgdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/WebRTCDataChannelGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/WebRTCDataChannelGDNative.xml. .. _class_WebRTCDataChannelGDNative: diff --git a/classes/class_webrtcmultiplayer.rst b/classes/class_webrtcmultiplayer.rst index 19c42622c..064d8aa18 100644 --- a/classes/class_webrtcmultiplayer.rst +++ b/classes/class_webrtcmultiplayer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webrtc/doc_classes/WebRTCMultiplayer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webrtc/doc_classes/WebRTCMultiplayer.xml. .. _class_WebRTCMultiplayer: diff --git a/classes/class_webrtcpeerconnection.rst b/classes/class_webrtcpeerconnection.rst index 78c278ffd..b3e8b909c 100644 --- a/classes/class_webrtcpeerconnection.rst +++ b/classes/class_webrtcpeerconnection.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webrtc/doc_classes/WebRTCPeerConnection.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webrtc/doc_classes/WebRTCPeerConnection.xml. .. _class_WebRTCPeerConnection: diff --git a/classes/class_webrtcpeerconnectiongdnative.rst b/classes/class_webrtcpeerconnectiongdnative.rst index 88ac430f8..4657a5f4f 100644 --- a/classes/class_webrtcpeerconnectiongdnative.rst +++ b/classes/class_webrtcpeerconnectiongdnative.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/WebRTCPeerConnectionGDNative.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/WebRTCPeerConnectionGDNative.xml. .. _class_WebRTCPeerConnectionGDNative: diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 06535ce1e..180d01599 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/websocket/doc_classes/WebSocketClient.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/websocket/doc_classes/WebSocketClient.xml. .. _class_WebSocketClient: diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index b5d4cfa9c..9428f1ff6 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. .. _class_WebSocketMultiplayerPeer: diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 9bc0fc3c9..66291427a 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/websocket/doc_classes/WebSocketPeer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/websocket/doc_classes/WebSocketPeer.xml. .. _class_WebSocketPeer: diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index ef26a0216..293213ba8 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/websocket/doc_classes/WebSocketServer.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/websocket/doc_classes/WebSocketServer.xml. .. _class_WebSocketServer: diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index efc9d07e7..1bc0d2025 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webxr/doc_classes/WebXRInterface.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webxr/doc_classes/WebXRInterface.xml. .. _class_WebXRInterface: diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index be1f4e51e..9ef75f260 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/WindowDialog.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/WindowDialog.xml. .. _class_WindowDialog: diff --git a/classes/class_world.rst b/classes/class_world.rst index 25f186c33..830349703 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/World.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/World.xml. .. _class_World: diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 8c7553ce6..508cd9519 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/World2D.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/World2D.xml. .. _class_World2D: diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index c7cf24868..d6346baee 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/WorldEnvironment.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/WorldEnvironment.xml. .. _class_WorldEnvironment: diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index 4c4e8605d..a5c664d7a 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/X509Certificate.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/X509Certificate.xml. .. _class_X509Certificate: diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index ff8df44df..0ccb9a086 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/XMLParser.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/XMLParser.xml. .. _class_XMLParser: diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 02de32fdc..bfcdd58a1 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -2,8 +2,8 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/YSort.xml. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/YSort.xml. .. _class_YSort: diff --git a/classes/index.rst b/classes/index.rst index 94019793d..c347b23e5 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -2,7 +2,7 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. +.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. _doc_class_reference: @@ -133,8 +133,10 @@ Nodes class_linkbutton class_listener class_listener2d + class_lod class_margincontainer class_menubutton + class_mergegroup class_meshinstance class_meshinstance2d class_multimeshinstance @@ -351,11 +353,13 @@ Resources class_gltfanimation class_gltfbufferview class_gltfcamera + class_gltfcollider class_gltfdocument class_gltfdocumentextension class_gltflight class_gltfmesh class_gltfnode + class_gltfphysicsbody class_gltfskeleton class_gltfskin class_gltfspecgloss @@ -386,6 +390,7 @@ Resources class_largetexture class_lineshape2d class_material + class_material3d class_mesh class_meshlibrary class_meshtexture @@ -399,6 +404,7 @@ Resources class_occludershapepolygon class_occludershapesphere class_opensimplexnoise + class_ormspatialmaterial class_packeddatacontainer class_packedscene class_packedscenegltf