From 03d40ff29ef956e46064f396e87184d8aa6a8270 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 13 Mar 2020 17:17:50 +0100 Subject: [PATCH] Sync classref with master branch (4.0 changes) --- classes/class_@gdscript.rst | 39 +- classes/class_@globalscope.rst | 220 +- classes/class_acceptdialog.rst | 2 +- classes/class_animatedsprite.rst | 94 +- classes/class_animatedsprite3d.rst | 38 +- classes/class_animatedtexture.rst | 42 +- classes/class_animation.rst | 80 +- classes/class_animationnode.rst | 86 +- classes/class_animationnodeanimation.rst | 10 +- classes/class_animationnodeblendtree.rst | 93 +- classes/class_animationnodeoneshot.rst | 11 + classes/class_animationnodeoutput.rst | 2 +- classes/class_animationnodestatemachine.rst | 120 +- ...lass_animationnodestatemachineplayback.rst | 34 +- ...ss_animationnodestatemachinetransition.rst | 6 +- classes/class_animationnodetimescale.rst | 5 + classes/class_animationnodetimeseek.rst | 5 + classes/class_animationnodetransition.rst | 9 + classes/class_animationplayer.rst | 128 +- classes/class_animationtree.rst | 18 +- classes/class_animationtreeplayer.rst | 766 ----- classes/class_area.rst | 12 +- classes/class_area2d.rst | 6 +- classes/class_array.rst | 230 +- classes/class_arraymesh.rst | 110 +- classes/class_arvrcontroller.rst | 4 +- classes/class_arvrinterface.rst | 4 +- classes/class_arvrpositionaltracker.rst | 14 +- classes/class_arvrserver.rst | 8 +- classes/class_astar.rst | 108 +- classes/class_astar2d.rst | 100 +- classes/class_atlastexture.rst | 28 +- classes/class_audioeffectcompressor.rst | 34 +- classes/class_audioeffectrecord.rst | 13 + classes/class_audioserver.rst | 12 +- .../class_audiostreamgeneratorplayback.rst | 28 +- classes/class_audiostreamoggvorbis.rst | 30 +- classes/class_audiostreamplayer.rst | 38 +- classes/class_audiostreamplayer2d.rst | 46 +- classes/class_audiostreamplayer3d.rst | 82 +- classes/class_audiostreamsample.rst | 46 +- classes/class_bakedlightmap.rst | 312 -- classes/class_bakedlightmapdata.rst | 147 - classes/class_basematerial3d.rst | 2326 +++++++++++++ classes/class_basis.rst | 4 +- classes/class_bitmapfont.rst | 8 +- classes/class_boxcontainer.rst | 14 +- classes/class_button.rst | 4 +- classes/class_callable.rst | 128 + classes/class_camera.rst | 14 + classes/class_cameraeffects.rst | 165 + classes/class_camerafeed.rst | 119 - classes/class_cameratexture.rst | 18 +- classes/class_canvasitem.rst | 360 +- classes/class_canvasitemmaterial.rst | 4 +- classes/class_checkbox.rst | 78 +- classes/class_checkbutton.rst | 78 +- classes/class_classdb.rst | 122 +- classes/class_collisionpolygon.rst | 30 +- classes/class_collisionpolygon2d.rst | 42 +- classes/class_collisionshape2d.rst | 2 +- classes/class_color.rst | 107 +- classes/class_colorpicker.rst | 64 +- classes/class_colorpickerbutton.rst | 50 +- classes/class_concavepolygonshape.rst | 16 +- classes/class_concavepolygonshape2d.rst | 22 +- classes/class_configfile.rst | 112 +- classes/class_container.rst | 7 + classes/class_control.rst | 88 +- classes/class_convexpolygonshape.rst | 22 +- classes/class_convexpolygonshape2d.rst | 30 +- classes/class_cpuparticles.rst | 268 +- classes/class_cpuparticles2d.rst | 20 +- classes/class_crypto.rst | 6 +- classes/class_csgpolygon.rst | 70 +- classes/class_csharpscript.rst | 8 +- classes/class_cubemap.rst | 190 +- classes/class_cubemaparray.rst | 15 + classes/class_curve2d.rst | 80 +- classes/class_curve3d.rst | 108 +- classes/class_curvetexture.rst | 2 +- classes/class_dictionary.rst | 8 +- classes/class_directionallight.rst | 16 + classes/class_directory.rst | 6 +- classes/class_dtlsserver.rst | 103 + classes/class_dynamicfont.rst | 36 - classes/class_editorexportplugin.rst | 60 +- classes/class_editorfeatureprofile.rst | 58 +- classes/class_editorfiledialog.rst | 4 +- classes/class_editorfilesystem.rst | 6 +- classes/class_editorfilesystemdirectory.rst | 4 +- classes/class_editorinspector.rst | 5 + classes/class_editorinspectorplugin.rst | 4 +- classes/class_editorinterface.rst | 2 +- classes/class_editorplugin.rst | 32 +- classes/class_editorproperty.rst | 46 +- classes/class_editorresourcepreview.rst | 26 +- .../class_editorresourcepreviewgenerator.rst | 26 +- classes/class_editorsceneimporterassimp.rst | 4 +- classes/class_editorsettings.rst | 76 +- classes/class_editorspatialgizmo.rst | 76 +- classes/class_editorspatialgizmoplugin.rst | 12 +- classes/class_engine.rst | 4 +- classes/class_environment.rst | 816 ++--- classes/class_expression.rst | 4 +- classes/class_file.rst | 192 +- classes/class_filedialog.rst | 88 +- classes/class_font.rst | 2 + classes/class_funcref.rst | 24 +- classes/class_gdnative.rst | 16 +- classes/class_gdnativelibrary.rst | 12 +- classes/class_gdscript.rst | 12 +- classes/class_geometry.rst | 200 +- classes/class_geometryinstance.rst | 28 +- classes/class_giprobe.rst | 144 +- classes/class_giprobedata.rst | 232 +- classes/class_gradient.rst | 46 +- classes/class_gradienttexture.rst | 2 +- classes/class_graphedit.rst | 136 +- classes/class_graphnode.rst | 182 +- classes/class_gridcontainer.rst | 8 +- classes/class_hashingcontext.rst | 18 +- classes/class_heightmapshape.rst | 30 +- classes/class_hingejoint.rst | 8 + classes/class_hscrollbar.rst | 38 +- classes/class_hslider.rst | 26 +- classes/class_hsplitcontainer.rst | 18 +- classes/class_httpclient.rst | 66 +- classes/class_httprequest.rst | 26 +- classes/class_image.rst | 326 +- classes/class_imagetexture.rst | 129 +- classes/class_immediategeometry.rst | 4 +- classes/class_input.rst | 34 +- classes/class_inputevent.rst | 16 +- classes/class_inputeventaction.rst | 18 +- classes/class_inputeventgesture.rst | 4 +- classes/class_inputeventkey.rst | 100 +- classes/class_inputmap.rst | 70 +- classes/class_instanceplaceholder.rst | 16 +- classes/class_itemlist.rst | 174 +- classes/class_kinematicbody.rst | 4 +- classes/class_kinematicbody2d.rst | 4 +- classes/class_largetexture.rst | 59 +- classes/class_light.rst | 14 +- classes/class_light2d.rst | 120 +- classes/class_line2d.rst | 24 +- classes/class_lineedit.rst | 62 +- classes/class_lineshape2d.rst | 24 +- classes/class_linkbutton.rst | 4 + classes/class_mainloop.rst | 64 +- classes/class_marshalls.rst | 36 +- classes/class_material.rst | 4 +- classes/class_mesh.rst | 84 +- classes/class_meshdatatool.rst | 168 +- classes/class_meshinstance2d.rst | 20 +- classes/class_meshlibrary.rst | 84 +- classes/class_meshtexture.rst | 20 +- classes/class_monogchandle.rst | 15 + classes/class_multimesh.rst | 172 +- classes/class_multimeshinstance2d.rst | 10 +- classes/class_multiplayerapi.rst | 54 +- classes/class_nativescript.rst | 28 +- classes/class_navigation.rst | 118 +- classes/class_navigation2d.rst | 102 +- classes/class_navigation2dserver.rst | 296 ++ classes/class_navigationagent.rst | 357 ++ classes/class_navigationagent2d.rst | 321 ++ classes/class_navigationmesh.rst | 134 +- ....rst => class_navigationmeshgenerator.rst} | 22 +- classes/class_navigationmeshinstance.rst | 51 - classes/class_navigationobstacle.rst | 46 + classes/class_navigationobstacle2d.rst | 46 + classes/class_navigationpolygon.rst | 94 +- classes/class_navigationregion.rst | 93 + ...tance.rst => class_navigationregion2d.rst} | 22 +- classes/class_navigationserver.rst | 370 +++ classes/class_networkedmultiplayerenet.rst | 58 + classes/class_ninepatchrect.rst | 4 +- classes/class_node.rst | 380 +-- classes/class_node2d.rst | 2 +- classes/class_noisetexture.rst | 32 +- classes/class_object.rst | 228 +- classes/class_occluderpolygon2d.rst | 30 +- classes/class_omnilight.rst | 46 +- classes/class_opensimplexnoise.rst | 4 +- classes/class_optionbutton.rst | 146 +- classes/class_ormmaterial3d.rst | 15 + classes/class_os.rst | 514 ++- classes/class_packedbytearray.rst | 201 ++ ...r3array.rst => class_packedcolorarray.rst} | 76 +- classes/class_packeddatacontainer.rst | 14 +- classes/class_packeddatacontainerref.rst | 2 +- classes/class_packedfloat32array.rst | 138 + classes/class_packedfloat64array.rst | 138 + classes/class_packedint32array.rst | 138 + ...r2array.rst => class_packedint64array.rst} | 82 +- classes/class_packedscene.rst | 12 +- classes/class_packedstringarray.rst | 136 + classes/class_packedvector2array.rst | 136 + classes/class_packedvector3array.rst | 136 + classes/class_packetpeer.rst | 64 +- classes/class_packetpeerdtls.rst | 93 + classes/class_packetpeerudp.rst | 22 + classes/class_panelcontainer.rst | 7 + classes/class_panoramasky.rst | 14 +- classes/class_parallaxlayer.rst | 2 +- classes/class_particles.rst | 4 +- classes/class_particles2d.rst | 12 +- classes/class_particlesmaterial.rst | 108 +- classes/class_performance.rst | 56 +- classes/class_physicalbone.rst | 8 - classes/class_physics2dserver.rst | 12 +- classes/class_physicsserver.rst | 464 +-- classes/class_pinjoint.rst | 4 + classes/class_plane.rst | 4 +- classes/class_pointmesh.rst | 2 +- classes/class_polygon2d.rst | 228 +- classes/class_polygonpathfinder.rst | 40 +- classes/class_poolbytearray.rst | 201 -- classes/class_poolcolorarray.rst | 136 - classes/class_poolintarray.rst | 138 - classes/class_poolrealarray.rst | 136 - classes/class_poolstringarray.rst | 146 - classes/class_popupmenu.rst | 302 +- classes/class_primitivemesh.rst | 2 +- classes/class_proceduralsky.rst | 2 +- classes/class_projectsettings.rst | 1760 +++++----- classes/class_proxytexture.rst | 12 +- classes/class_rect2.rst | 22 +- classes/class_rect2i.rst | 57 + classes/class_reference.rst | 2 +- classes/class_reflectionprobe.rst | 4 +- classes/class_regex.rst | 6 +- classes/class_renderingdevice.rst | 15 + classes/class_resource.rst | 4 +- classes/class_resourceformatloader.rst | 30 +- classes/class_resourceformatsaver.rst | 16 +- classes/class_resourceinteractiveloader.rst | 86 - classes/class_resourceloader.rst | 99 +- classes/class_resourcepreloader.rst | 38 +- classes/class_resourcesaver.rst | 12 +- classes/class_richtextlabel.rst | 8 +- classes/class_rigidbody.rst | 36 - classes/class_rigidbody2d.rst | 36 - classes/class_scenestate.rst | 94 +- classes/class_scenetree.rst | 126 +- classes/class_script.rst | 70 +- classes/class_scripteditor.rst | 2 +- classes/class_scrollcontainer.rst | 6 +- classes/class_semaphore.rst | 28 +- classes/class_shader.rst | 24 +- classes/class_shadermaterial.rst | 22 +- classes/class_shape.rst | 2 +- classes/class_signal.rst | 117 + classes/class_skeleton.rst | 22 + classes/class_skeleton2d.rst | 11 +- classes/class_skeletonik.rst | 50 +- classes/class_skin.rst | 50 +- classes/class_sky.rst | 34 + classes/class_spatial.rst | 2 +- classes/class_spatialmaterial.rst | 2256 ------------- classes/class_spinbox.rst | 6 +- classes/class_springarm.rst | 6 +- classes/class_sprite.rst | 112 +- classes/class_sprite3d.rst | 36 +- classes/class_spritebase3d.rst | 62 +- classes/class_spriteframes.rst | 96 +- classes/class_standardmaterial3d.rst | 15 + classes/class_staticbody.rst | 36 - classes/class_staticbody2d.rst | 36 - classes/class_streampeer.rst | 8 +- classes/class_streampeerbuffer.rst | 22 +- classes/class_streampeerssl.rst | 4 +- classes/class_streamtexture.rst | 12 +- classes/class_string.rst | 538 +-- classes/class_stringname.rst | 34 + classes/class_styleboxtexture.rst | 8 +- classes/class_surfacetool.rst | 102 +- classes/class_tabcontainer.rst | 136 +- classes/class_tabs.rst | 154 +- classes/class_textedit.rst | 342 +- classes/class_texture.rst | 162 +- classes/class_texture2d.rst | 112 + classes/class_texture2darray.rst | 15 + classes/class_texture3d.rst | 27 - classes/class_texturearray.rst | 20 - classes/class_texturebutton.rst | 20 +- classes/class_texturelayered.rst | 127 +- classes/class_textureprogress.rst | 18 +- classes/class_texturerect.rst | 6 +- classes/class_theme.rst | 196 +- classes/class_thread.rst | 20 +- classes/class_tileset.rst | 16 +- classes/class_touchscreenbutton.rst | 8 +- classes/class_transform.rst | 12 +- classes/class_transform2d.rst | 12 +- classes/class_translation.rst | 30 +- classes/class_translationserver.rst | 36 +- classes/class_tree.rst | 152 +- classes/class_treeitem.rst | 270 +- classes/class_tween.rst | 128 +- classes/class_udpserver.rst | 123 + classes/class_undoredo.rst | 74 +- classes/class_upnp.rst | 2 +- classes/class_vector2.rst | 14 +- classes/class_vector2i.rst | 84 + classes/class_vector3.rst | 14 +- classes/class_vector3i.rst | 96 + classes/class_videoplayer.rst | 72 +- classes/class_viewport.rst | 328 +- classes/class_viewporttexture.rst | 6 +- classes/class_visualinstance.rst | 2 +- classes/class_visualscript.rst | 254 +- .../class_visualscriptbasictypeconstant.rst | 4 +- classes/class_visualscriptbuiltinfunc.rst | 8 +- classes/class_visualscriptclassconstant.rst | 18 +- classes/class_visualscriptemitsignal.rst | 10 +- classes/class_visualscriptfunctioncall.rst | 52 +- classes/class_visualscriptinputaction.rst | 14 +- classes/class_visualscriptlocalvar.rst | 14 +- classes/class_visualscriptlocalvarset.rst | 14 +- classes/class_visualscriptpropertyget.rst | 40 +- classes/class_visualscriptpropertyset.rst | 44 +- classes/class_visualscripttypecast.rst | 14 +- classes/class_visualscriptvariableget.rst | 10 +- classes/class_visualscriptvariableset.rst | 10 +- classes/class_visualscriptyieldsignal.rst | 26 +- classes/class_visualserver.rst | 2928 ++++++----------- classes/class_visualshader.rst | 54 +- classes/class_visualshadernode.rst | 20 +- classes/class_visualshadernodecompare.rst | 12 +- classes/class_visualshadernodecubemap.rst | 50 +- .../class_visualshadernodecubemapuniform.rst | 10 +- classes/class_visualshadernodecustom.rst | 70 +- ...> class_visualshadernodefloatconstant.rst} | 23 +- classes/class_visualshadernodefloatfunc.rst | 179 + classes/class_visualshadernodefloatop.rst | 91 + .../class_visualshadernodefloatuniform.rst | 117 + classes/class_visualshadernodeif.rst | 5 + classes/class_visualshadernodeinput.rst | 8 +- classes/class_visualshadernodeintconstant.rst | 44 + classes/class_visualshadernodeintfunc.rst | 67 + classes/class_visualshadernodeintop.rst | 79 + classes/class_visualshadernodeintuniform.rst | 117 + classes/class_visualshadernodescalarfunc.rst | 172 - classes/class_visualshadernodescalarop.rst | 84 - .../class_visualshadernodescalaruniform.rst | 15 - classes/class_visualshadernodetexture.rst | 4 +- .../class_visualshadernodetextureuniform.rst | 2 +- classes/class_visualshadernodeuniform.rst | 2 +- classes/class_vscrollbar.rst | 38 +- classes/class_vslider.rst | 26 +- classes/class_vsplitcontainer.rst | 18 +- classes/class_websocketclient.rst | 20 +- classes/class_websocketserver.rst | 32 +- classes/class_windowdialog.rst | 38 +- classes/class_world.rst | 14 + classes/class_worldenvironment.rst | 20 +- ...neshape.rst => class_worldmarginshape.rst} | 20 +- classes/class_xmlparser.rst | 4 +- 360 files changed, 17483 insertions(+), 16479 deletions(-) delete mode 100644 classes/class_animationtreeplayer.rst delete mode 100644 classes/class_bakedlightmap.rst delete mode 100644 classes/class_bakedlightmapdata.rst create mode 100644 classes/class_basematerial3d.rst create mode 100644 classes/class_callable.rst create mode 100644 classes/class_cameraeffects.rst create mode 100644 classes/class_cubemaparray.rst create mode 100644 classes/class_dtlsserver.rst create mode 100644 classes/class_monogchandle.rst create mode 100644 classes/class_navigation2dserver.rst create mode 100644 classes/class_navigationagent.rst create mode 100644 classes/class_navigationagent2d.rst rename classes/{class_editornavigationmeshgenerator.rst => class_navigationmeshgenerator.rst} (52%) delete mode 100644 classes/class_navigationmeshinstance.rst create mode 100644 classes/class_navigationobstacle.rst create mode 100644 classes/class_navigationobstacle2d.rst create mode 100644 classes/class_navigationregion.rst rename classes/{class_navigationpolygoninstance.rst => class_navigationregion2d.rst} (67%) create mode 100644 classes/class_navigationserver.rst create mode 100644 classes/class_ormmaterial3d.rst create mode 100644 classes/class_packedbytearray.rst rename classes/{class_poolvector3array.rst => class_packedcolorarray.rst} (64%) create mode 100644 classes/class_packedfloat32array.rst create mode 100644 classes/class_packedfloat64array.rst create mode 100644 classes/class_packedint32array.rst rename classes/{class_poolvector2array.rst => class_packedint64array.rst} (60%) create mode 100644 classes/class_packedstringarray.rst create mode 100644 classes/class_packedvector2array.rst create mode 100644 classes/class_packedvector3array.rst create mode 100644 classes/class_packetpeerdtls.rst delete mode 100644 classes/class_poolbytearray.rst delete mode 100644 classes/class_poolcolorarray.rst delete mode 100644 classes/class_poolintarray.rst delete mode 100644 classes/class_poolrealarray.rst delete mode 100644 classes/class_poolstringarray.rst create mode 100644 classes/class_rect2i.rst create mode 100644 classes/class_renderingdevice.rst delete mode 100644 classes/class_resourceinteractiveloader.rst create mode 100644 classes/class_signal.rst delete mode 100644 classes/class_spatialmaterial.rst create mode 100644 classes/class_standardmaterial3d.rst create mode 100644 classes/class_stringname.rst create mode 100644 classes/class_texture2d.rst create mode 100644 classes/class_texture2darray.rst delete mode 100644 classes/class_texture3d.rst delete mode 100644 classes/class_texturearray.rst create mode 100644 classes/class_udpserver.rst create mode 100644 classes/class_vector2i.rst create mode 100644 classes/class_vector3i.rst rename classes/{class_visualshadernodescalarconstant.rst => class_visualshadernodefloatconstant.rst} (59%) create mode 100644 classes/class_visualshadernodefloatfunc.rst create mode 100644 classes/class_visualshadernodefloatop.rst create mode 100644 classes/class_visualshadernodefloatuniform.rst create mode 100644 classes/class_visualshadernodeintconstant.rst create mode 100644 classes/class_visualshadernodeintfunc.rst create mode 100644 classes/class_visualshadernodeintop.rst create mode 100644 classes/class_visualshadernodeintuniform.rst delete mode 100644 classes/class_visualshadernodescalarfunc.rst delete mode 100644 classes/class_visualshadernodescalarop.rst delete mode 100644 classes/class_visualshadernodescalaruniform.rst rename classes/{class_planeshape.rst => class_worldmarginshape.rst} (61%) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 7d16ca34a..e16782b4a 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -36,7 +36,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes, :ref:`bool` allow_objects=false **)** | +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PackedByteArray` bytes, :ref:`bool` allow_objects=false **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,8 +54,6 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`db2linear` **(** :ref:`float` db **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`decimals` **(** :ref:`float` step **)** | -+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`dectime` **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | @@ -194,7 +192,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | +| :ref:`PackedByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -348,7 +346,7 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` .. _class_@GDScript_method_bytes2var: -- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes, :ref:`bool` allow_objects=false **)** +- :ref:`Variant` **bytes2var** **(** :ref:`PackedByteArray` bytes, :ref:`bool` allow_objects=false **)** Decodes a byte array back to a value. When ``allow_objects`` is ``true`` decoding objects is allowed. @@ -463,14 +461,6 @@ Converts from decibels to linear energy (audio). ---- -.. _class_@GDScript_method_decimals: - -- :ref:`int` **decimals** **(** :ref:`float` step **)** - -Deprecated alias for :ref:`step_decimals`. - ----- - .. _class_@GDScript_method_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** @@ -688,11 +678,15 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** -Returns a normalized value considering the given range. +Returns a normalized value considering the given range. This is the opposite of :ref:`lerp`. :: - inverse_lerp(3, 5, 4) # Returns 0.5 + var middle = lerp(20, 30, 0.75) + # `middle` is now 27.5. + # Now, we pretend to have forgotten the original ratio and want to get it back. + var ratio = inverse_lerp(20, 30, 27.5) + # `ratio` is now 0.75. ---- @@ -755,7 +749,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem - :ref:`Variant` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** -Linearly interpolates between two values by a normalized value. +Linearly interpolates between two values by a normalized value. This is the opposite of :ref:`inverse_lerp`. If the ``from`` and ``to`` arguments are of type :ref:`int` or :ref:`float`, the return value is a :ref:`float`. @@ -774,7 +768,7 @@ If both are of the same vector type (:ref:`Vector2`, :ref:`Vector Linearly interpolates between two angles (in radians) by a normalized value. -Similar to :ref:`lerp` but interpolate correctly when the angles wrap around :ref:`TAU`. +Similar to :ref:`lerp`, but interpolates correctly when the angles wrap around :ref:`TAU`. :: @@ -792,7 +786,14 @@ Similar to :ref:`lerp` but interpolate correctly wh - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** -Converts from linear energy to decibels (audio). +Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). Example: + +:: + + # "Slider" refers to a node that inherits Range such as HSlider or VSlider. + # Its range must be configured to go from 0 to 1. + # Change the bus name if you'd like to change the volume of a specific bus only. + AudioServer.set_bus_volume_db(AudioServer.get_bus_index("Master"), linear2db($Slider.value)) ---- @@ -1448,7 +1449,7 @@ Checks that ``json`` is valid JSON data. Returns an empty string if valid, or an .. _class_@GDScript_method_var2bytes: -- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** +- :ref:`PackedByteArray` **var2bytes** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 78dfa9064..73577e55d 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -14,62 +14,68 @@ Global scope constants and variables. Description ----------- -Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. +Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc. Singletons are also documented here, since they can be accessed from anywhere. Properties ---------- -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`ARVRServer` | :ref:`ARVRServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`AudioServer` | :ref:`AudioServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`CameraServer` | :ref:`CameraServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`ClassDB` | :ref:`ClassDB` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Engine` | :ref:`Engine` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Geometry` | :ref:`Geometry` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`IP` | :ref:`IP` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Input` | :ref:`Input` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`InputMap` | :ref:`InputMap` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`JSON` | :ref:`JSON` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`JavaClassWrapper` | :ref:`JavaClassWrapper` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`JavaScript` | :ref:`JavaScript` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`Marshalls` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`EditorNavigationMeshGenerator` | :ref:`NavigationMeshGenerator` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`OS` | :ref:`OS` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Performance` | :ref:`Performance` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`Physics2DServer` | :ref:`Physics2DServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`PhysicsServer` | :ref:`PhysicsServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`ProjectSettings` | :ref:`ProjectSettings` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`ResourceLoader` | :ref:`ResourceLoader` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`ResourceSaver` | :ref:`ResourceSaver` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`TranslationServer` | :ref:`TranslationServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`VisualServer` | :ref:`VisualServer` | -+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ARVRServer` | :ref:`ARVRServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`AudioServer` | :ref:`AudioServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`CameraServer` | :ref:`CameraServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ClassDB` | :ref:`ClassDB` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Engine` | :ref:`Engine` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Geometry` | :ref:`Geometry` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`GodotSharp` | :ref:`GodotSharp` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`IP` | :ref:`IP` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Input` | :ref:`Input` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`InputMap` | :ref:`InputMap` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`JSON` | :ref:`JSON` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`JavaClassWrapper` | :ref:`JavaClassWrapper` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`JavaScript` | :ref:`JavaScript` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Marshalls` | :ref:`Marshalls` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Navigation2DServer` | :ref:`Navigation2DServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`NavigationMeshGenerator` | :ref:`NavigationMeshGenerator` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`NavigationServer` | :ref:`NavigationServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`OS` | :ref:`OS` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Performance` | :ref:`Performance` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`Physics2DServer` | :ref:`Physics2DServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PhysicsServer` | :ref:`PhysicsServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ProjectSettings` | :ref:`ProjectSettings` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ResourceLoader` | :ref:`ResourceLoader` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`ResourceSaver` | :ref:`ResourceSaver` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`TranslationServer` | :ref:`TranslationServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`VisualScriptEditor` | :ref:`VisualScriptEditor` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`VisualServer` | :ref:`VisualServer` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ Enumerations ------------ @@ -1855,7 +1861,7 @@ enum **PropertyHint**: - **PROPERTY_HINT_GLOBAL_DIR** = **16** --- Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path. -- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource`-derived type, optionally specified via the hint string (e.g. ``"Texture"``). Editing it will show a popup menu of valid resource types to instantiate. +- **PROPERTY_HINT_RESOURCE_TYPE** = **17** --- Hints that a property is an instance of a :ref:`Resource`-derived type, optionally specified via the hint string (e.g. ``"Texture2D"``). Editing it will show a popup menu of valid resource types to instantiate. - **PROPERTY_HINT_MULTILINE_TEXT** = **18** --- Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed. @@ -1987,10 +1993,16 @@ enum **MethodFlags**: .. _class_@GlobalScope_constant_TYPE_VECTOR2: +.. _class_@GlobalScope_constant_TYPE_VECTOR2I: + .. _class_@GlobalScope_constant_TYPE_RECT2: +.. _class_@GlobalScope_constant_TYPE_RECT2I: + .. _class_@GlobalScope_constant_TYPE_VECTOR3: +.. _class_@GlobalScope_constant_TYPE_VECTOR3I: + .. _class_@GlobalScope_constant_TYPE_TRANSFORM2D: .. _class_@GlobalScope_constant_TYPE_PLANE: @@ -2005,21 +2017,31 @@ enum **MethodFlags**: .. _class_@GlobalScope_constant_TYPE_COLOR: +.. _class_@GlobalScope_constant_TYPE_STRING_NAME: + .. _class_@GlobalScope_constant_TYPE_NODE_PATH: .. _class_@GlobalScope_constant_TYPE_RID: .. _class_@GlobalScope_constant_TYPE_OBJECT: +.. _class_@GlobalScope_constant_TYPE_CALLABLE: + +.. _class_@GlobalScope_constant_TYPE_SIGNAL: + .. _class_@GlobalScope_constant_TYPE_DICTIONARY: .. _class_@GlobalScope_constant_TYPE_ARRAY: .. _class_@GlobalScope_constant_TYPE_RAW_ARRAY: -.. _class_@GlobalScope_constant_TYPE_INT_ARRAY: +.. _class_@GlobalScope_constant_TYPE_INT32_ARRAY: -.. _class_@GlobalScope_constant_TYPE_REAL_ARRAY: +.. _class_@GlobalScope_constant_TYPE_INT64_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_FLOAT32_ARRAY: + +.. _class_@GlobalScope_constant_TYPE_FLOAT64_ARRAY: .. _class_@GlobalScope_constant_TYPE_STRING_ARRAY: @@ -2045,49 +2067,65 @@ enum **Variant.Type**: - **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2`. -- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2`. +- **TYPE_VECTOR2I** = **6** --- Variable is of type :ref:`Vector2i`. -- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3`. +- **TYPE_RECT2** = **7** --- Variable is of type :ref:`Rect2`. -- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D`. +- **TYPE_RECT2I** = **8** --- Variable is of type :ref:`Rect2i`. -- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. +- **TYPE_VECTOR3** = **9** --- Variable is of type :ref:`Vector3`. -- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. +- **TYPE_VECTOR3I** = **10** --- Variable is of type :ref:`Vector3i`. -- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. +- **TYPE_TRANSFORM2D** = **11** --- Variable is of type :ref:`Transform2D`. -- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. +- **TYPE_PLANE** = **12** --- Variable is of type :ref:`Plane`. -- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. +- **TYPE_QUAT** = **13** --- Variable is of type :ref:`Quat`. -- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. +- **TYPE_AABB** = **14** --- Variable is of type :ref:`AABB`. -- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath`. +- **TYPE_BASIS** = **15** --- Variable is of type :ref:`Basis`. -- **TYPE_RID** = **16** --- Variable is of type :ref:`RID`. +- **TYPE_TRANSFORM** = **16** --- Variable is of type :ref:`Transform`. -- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object`. +- **TYPE_COLOR** = **17** --- Variable is of type :ref:`Color`. -- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary`. +- **TYPE_STRING_NAME** = **18** --- Variable is of type :ref:`StringName`. -- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array`. +- **TYPE_NODE_PATH** = **19** --- Variable is of type :ref:`NodePath`. -- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray`. +- **TYPE_RID** = **20** --- Variable is of type :ref:`RID`. -- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray`. +- **TYPE_OBJECT** = **21** --- Variable is of type :ref:`Object`. -- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray`. +- **TYPE_CALLABLE** = **22** --- Variable is of type :ref:`Callable`. -- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray`. +- **TYPE_SIGNAL** = **23** --- Variable is of type :ref:`Signal`. -- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array`. +- **TYPE_DICTIONARY** = **24** --- Variable is of type :ref:`Dictionary`. -- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array`. +- **TYPE_ARRAY** = **25** --- Variable is of type :ref:`Array`. -- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray`. +- **TYPE_RAW_ARRAY** = **26** --- Variable is of type :ref:`PackedByteArray`. -- **TYPE_MAX** = **27** --- Represents the size of the :ref:`Variant.Type` enum. +- **TYPE_INT32_ARRAY** = **27** --- Variable is of type :ref:`PackedInt32Array`. + +- **TYPE_INT64_ARRAY** = **28** --- Variable is of type :ref:`PackedInt64Array`. + +- **TYPE_FLOAT32_ARRAY** = **29** --- Variable is of type :ref:`PackedFloat32Array`. + +- **TYPE_FLOAT64_ARRAY** = **30** --- Variable is of type :ref:`PackedFloat64Array`. + +- **TYPE_STRING_ARRAY** = **31** --- Variable is of type :ref:`PackedStringArray`. + +- **TYPE_VECTOR2_ARRAY** = **32** --- Variable is of type :ref:`PackedVector2Array`. + +- **TYPE_VECTOR3_ARRAY** = **33** --- Variable is of type :ref:`PackedVector3Array`. + +- **TYPE_COLOR_ARRAY** = **34** --- Variable is of type :ref:`PackedColorArray`. + +- **TYPE_MAX** = **35** --- Represents the size of the :ref:`Variant.Type` enum. ---- @@ -2204,7 +2242,7 @@ Constants .. _class_@GlobalScope_constant_SPKEY: -- **SPKEY** = **16777216** --- Scancodes with this bit applied are non-printable. +- **SPKEY** = **16777216** --- Keycodes with this bit applied are non-printable. Property Descriptions --------------------- @@ -2257,6 +2295,14 @@ The :ref:`Geometry` singleton. ---- +.. _class_@GlobalScope_property_GodotSharp: + +- :ref:`GodotSharp` **GodotSharp** + +The :ref:`GodotSharp` singleton. Only available when using Godot's Mono build. + +---- + .. _class_@GlobalScope_property_IP: - :ref:`IP` **IP** @@ -2311,17 +2357,33 @@ The :ref:`JavaScript` singleton. .. _class_@GlobalScope_property_Marshalls: -- :ref:`Reference` **Marshalls** +- :ref:`Marshalls` **Marshalls** The :ref:`Marshalls` singleton. ---- +.. _class_@GlobalScope_property_Navigation2DServer: + +- :ref:`Navigation2DServer` **Navigation2DServer** + +The :ref:`Navigation2DServer` singleton. + +---- + .. _class_@GlobalScope_property_NavigationMeshGenerator: -- :ref:`EditorNavigationMeshGenerator` **NavigationMeshGenerator** +- :ref:`NavigationMeshGenerator` **NavigationMeshGenerator** -The :ref:`EditorNavigationMeshGenerator` singleton. +The :ref:`NavigationMeshGenerator` singleton. + +---- + +.. _class_@GlobalScope_property_NavigationServer: + +- :ref:`NavigationServer` **NavigationServer** + +The :ref:`NavigationServer` singleton. ---- diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index ca7cd2838..7311aa148 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -61,7 +61,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed. .. _class_AcceptDialog_signal_custom_action: -- **custom_action** **(** :ref:`String` action **)** +- **custom_action** **(** :ref:`StringName` action **)** Emitted when a custom button is pressed. See :ref:`add_button`. diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 2371dc8db..bd74b043b 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -21,36 +21,40 @@ Animations are created using a :ref:`SpriteFrames` resource, Properties ---------- -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`animation` | ``"default"`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`centered` | ``true`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`flip_h` | ``false`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`flip_v` | ``false`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`int` | :ref:`frame` | ``0`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`SpriteFrames` | :ref:`frames` | | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`playing` | ``false`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`speed_scale` | ``1.0`` | -+-----------------------------------------+---------------------------------------------------------------+---------------------+ ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`StringName` | :ref:`animation` | ``@"default"`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`centered` | ``true`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`flip_h` | ``false`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`flip_v` | ``false`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`frame` | ``0`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`SpriteFrames` | :ref:`frames` | | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`playing` | ``false`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`shininess` | ``1.0`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`specular_color` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`speed_scale` | ``1.0`` | ++-----------------------------------------+---------------------------------------------------------------------+-------------------------+ Methods ------- -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`StringName` anim=@"", :ref:`bool` backwards=false **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -74,10 +78,10 @@ Property Descriptions .. _class_AnimatedSprite_property_animation: -- :ref:`String` **animation** +- :ref:`StringName` **animation** +-----------+----------------------+ -| *Default* | ``"default"`` | +| *Default* | ``@"default"`` | +-----------+----------------------+ | *Setter* | set_animation(value) | +-----------+----------------------+ @@ -194,6 +198,38 @@ If ``true``, the :ref:`animation` is cu ---- +.. _class_AnimatedSprite_property_shininess: + +- :ref:`float` **shininess** + ++-----------+----------------------+ +| *Default* | ``1.0`` | ++-----------+----------------------+ +| *Setter* | set_shininess(value) | ++-----------+----------------------+ +| *Getter* | get_shininess() | ++-----------+----------------------+ + +Strength of the specular light effect of this ``AnimatedSprite``. + +---- + +.. _class_AnimatedSprite_property_specular_color: + +- :ref:`Color` **specular_color** + ++-----------+---------------------------+ +| *Default* | ``Color( 1, 1, 1, 1 )`` | ++-----------+---------------------------+ +| *Setter* | set_specular_color(value) | ++-----------+---------------------------+ +| *Getter* | get_specular_color() | ++-----------+---------------------------+ + +The color of the specular light effect. + +---- + .. _class_AnimatedSprite_property_speed_scale: - :ref:`float` **speed_scale** @@ -221,7 +257,7 @@ Returns ``true`` if an animation is currently being played. .. _class_AnimatedSprite_method_play: -- void **play** **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** +- void **play** **(** :ref:`StringName` anim=@"", :ref:`bool` backwards=false **)** Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played. If ``backwards`` is ``true``, the animation will be played in reverse. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index ec71e5a69..660af2238 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -21,26 +21,26 @@ Animations are created using a :ref:`SpriteFrames` resource, Properties ---------- -+-----------------------------------------+-------------------------------------------------------------+---------------+ -| :ref:`String` | :ref:`animation` | ``"default"`` | -+-----------------------------------------+-------------------------------------------------------------+---------------+ -| :ref:`int` | :ref:`frame` | ``0`` | -+-----------------------------------------+-------------------------------------------------------------+---------------+ -| :ref:`SpriteFrames` | :ref:`frames` | | -+-----------------------------------------+-------------------------------------------------------------+---------------+ -| :ref:`bool` | :ref:`playing` | ``false`` | -+-----------------------------------------+-------------------------------------------------------------+---------------+ ++-----------------------------------------+-------------------------------------------------------------+----------------+ +| :ref:`StringName` | :ref:`animation` | ``@"default"`` | ++-----------------------------------------+-------------------------------------------------------------+----------------+ +| :ref:`int` | :ref:`frame` | ``0`` | ++-----------------------------------------+-------------------------------------------------------------+----------------+ +| :ref:`SpriteFrames` | :ref:`frames` | | ++-----------------------------------------+-------------------------------------------------------------+----------------+ +| :ref:`bool` | :ref:`playing` | ``false`` | ++-----------------------------------------+-------------------------------------------------------------+----------------+ Methods ------- -+-------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+-------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------+-------------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`StringName` anim=@"" **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------+ Signals ------- @@ -56,10 +56,10 @@ Property Descriptions .. _class_AnimatedSprite3D_property_animation: -- :ref:`String` **animation** +- :ref:`StringName` **animation** +-----------+----------------------+ -| *Default* | ``"default"`` | +| *Default* | ``@"default"`` | +-----------+----------------------+ | *Setter* | set_animation(value) | +-----------+----------------------+ @@ -123,7 +123,7 @@ Returns ``true`` if an animation is currently being played. .. _class_AnimatedSprite3D_method_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`StringName` anim=@"" **)** Plays the animation named ``anim``. If no ``anim`` is provided, the current animation is played. diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index 1cd19482f..2a05bf66a 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -9,14 +9,14 @@ AnimatedTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Proxy texture for simple frame-based animations. Description ----------- -``AnimatedTexture`` is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer` or :ref:`AnimatedSprite`, it isn't a :ref:`Node`, but has the advantage of being usable anywhere a :ref:`Texture` resource can be used, e.g. in a :ref:`TileSet`. +``AnimatedTexture`` is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer` or :ref:`AnimatedSprite`, it isn't a :ref:`Node`, but has the advantage of being usable anywhere a :ref:`Texture2D` resource can be used, e.g. in a :ref:`TileSet`. The playback of the animation is controlled by the :ref:`fps` property as well as each frame's optional delay (see :ref:`set_frame_delay`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. @@ -25,26 +25,24 @@ The playback of the animation is controlled by the :ref:`fps` | flags | **O:** ``0`` | -+---------------------------+------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`fps` | ``4.0`` | -+---------------------------+------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`frames` | ``1`` | -+---------------------------+------------------------------------------------------+--------------+ ++---------------------------+------------------------------------------------------+---------+ +| :ref:`float` | :ref:`fps` | ``4.0`` | ++---------------------------+------------------------------------------------------+---------+ +| :ref:`int` | :ref:`frames` | ``1`` | ++---------------------------+------------------------------------------------------+---------+ Methods ------- -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frame_delay` **(** :ref:`int` frame **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_delay` **(** :ref:`int` frame, :ref:`float` delay **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture` texture **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frame_delay` **(** :ref:`int` frame **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_delay` **(** :ref:`int` frame, :ref:`float` delay **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture2D` texture **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -101,9 +99,9 @@ Returns the given frame's delay value. .. _class_AnimatedTexture_method_get_frame_texture: -- :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** const +- :ref:`Texture2D` **get_frame_texture** **(** :ref:`int` frame **)** const -Returns the given frame's :ref:`Texture`. +Returns the given frame's :ref:`Texture2D`. ---- @@ -126,9 +124,9 @@ For example, for an animation with 3 frames, 2 FPS and a frame delay on the seco .. _class_AnimatedTexture_method_set_frame_texture: -- void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture` texture **)** +- void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture2D` texture **)** -Assigns a :ref:`Texture` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames` - 1. +Assigns a :ref:`Texture2D` to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID :ref:`frames` - 1. You can define any number of textures up to :ref:`MAX_FRAMES`, but keep in mind that only frames from 0 to :ref:`frames` - 1 will be part of the animation. diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 436b75989..9a7b0edde 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -28,7 +28,7 @@ An Animation resource contains data used to animate everything in the engine. An animation.track_insert_key(track_index, 0.0, 0) animation.track_insert_key(track_index, 0.5, 100) -Animations are just data containers, and must be added to nodes such as an :ref:`AnimationPlayer` or :ref:`AnimationTreePlayer` to be played back. +Animations are just data containers, and must be added to nodes such as an :ref:`AnimationPlayer` to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check :ref:`TrackType` to see available types. Tutorials --------- @@ -52,11 +52,11 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`StringName` | :ref:`animation_track_get_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`String` animation **)** | +| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track_idx, :ref:`float` time, :ref:`StringName` animation **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`String` animation **)** | +| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`StringName` animation **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,9 +96,9 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_track_count` **(** **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PackedInt32Array` | :ref:`method_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +| :ref:`StringName` | :ref:`method_track_get_name` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,7 +160,7 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` track_idx, :ref:`float` time_sec **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PackedInt32Array` | :ref:`value_track_get_key_indices` **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` track_idx **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -174,6 +174,8 @@ Signals - **tracks_changed** **(** **)** +Emitted when there's a change in the list of tracks, e.g. tracks are added, moved or have changed paths. + Enumerations ------------ @@ -199,11 +201,11 @@ enum **TrackType**: - **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key. -- **TYPE_BEZIER** = **3** +- **TYPE_BEZIER** = **3** --- Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a :ref:`Color`). -- **TYPE_AUDIO** = **4** +- **TYPE_AUDIO** = **4** --- Audio tracks are used to play an audio stream with either type of :ref:`AudioStreamPlayer`. The stream can be trimmed and previewed in the animation. -- **TYPE_ANIMATION** = **5** +- **TYPE_ANIMATION** = **5** --- Animation tracks play animations in other :ref:`AnimationPlayer` nodes. ---- @@ -243,7 +245,7 @@ enum **UpdateMode**: - **UPDATE_TRIGGER** = **2** --- Update at the keyframes. -- **UPDATE_CAPTURE** = **3** +- **UPDATE_CAPTURE** = **3** --- Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds. Property Descriptions --------------------- @@ -309,19 +311,25 @@ Adds a track to the Animation. .. _class_Animation_method_animation_track_get_key_animation: -- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`StringName` **animation_track_get_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const + +Returns the animation name at the key identified by ``key_idx``. The ``track_idx`` must be the index of an Animation Track. ---- .. _class_Animation_method_animation_track_insert_key: -- :ref:`int` **animation_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`String` animation **)** +- :ref:`int` **animation_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`StringName` animation **)** + +Inserts a key with value ``animation`` at the given ``time`` (in seconds). The ``track_idx`` must be the index of an Animation Track. ---- .. _class_Animation_method_animation_track_set_key_animation: -- void **animation_track_set_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`String` animation **)** +- void **animation_track_set_key_animation** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`StringName` animation **)** + +Sets the key identified by ``key_idx`` to value ``animation``. The ``track_idx`` must be the index of an Animation Track. ---- @@ -329,90 +337,128 @@ Adds a track to the Animation. - :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the end offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. + +End offset is the number of seconds cut off at the ending of the audio stream. + ---- .. _class_Animation_method_audio_track_get_key_start_offset: - :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the start offset of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. + +Start offset is the number of seconds cut off at the beginning of the audio stream. + ---- .. _class_Animation_method_audio_track_get_key_stream: - :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the audio stream of the key identified by ``key_idx``. The ``track_idx`` must be the index of an Audio Track. + ---- .. _class_Animation_method_audio_track_insert_key: - :ref:`int` **audio_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** +Inserts an Audio Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of an Audio Track. + +``stream`` is the :ref:`AudioStream` resource to play. ``start_offset`` is the number of seconds cut off at the beginning of the audio stream, while ``end_offset`` is at the ending. + ---- .. _class_Animation_method_audio_track_set_key_end_offset: - void **audio_track_set_key_end_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** +Sets the end offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. + ---- .. _class_Animation_method_audio_track_set_key_start_offset: - void **audio_track_set_key_start_offset** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` offset **)** +Sets the start offset of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. + ---- .. _class_Animation_method_audio_track_set_key_stream: - void **audio_track_set_key_stream** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Resource` stream **)** +Sets the stream of the key identified by ``key_idx`` to value ``offset``. The ``track_idx`` must be the index of an Audio Track. + ---- .. _class_Animation_method_bezier_track_get_key_in_handle: - :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the in handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_get_key_out_handle: - :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the out handle of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_get_key_value: - :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +Returns the value of the key identified by ``key_idx``. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_insert_key: - :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track_idx, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** +Inserts a Bezier Track key at the given ``time`` in seconds. The ``track_idx`` must be the index of a Bezier Track. + +``in_handle`` is the left-side weight of the added Bezier curve point, ``out_handle`` is the right-side one, while ``value`` is the actual value at this point. + ---- .. _class_Animation_method_bezier_track_interpolate: - :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track_idx, :ref:`float` time **)** const +Returns the interpolated value at the given ``time`` (in seconds). The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_set_key_in_handle: - void **bezier_track_set_key_in_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** +Sets the in handle of the key identified by ``key_idx`` to value ``in_handle``. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_set_key_out_handle: - void **bezier_track_set_key_out_handle** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** +Sets the out handle of the key identified by ``key_idx`` to value ``out_handle``. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_bezier_track_set_key_value: - void **bezier_track_set_key_value** **(** :ref:`int` track_idx, :ref:`int` key_idx, :ref:`float` value **)** +Sets the value of the key identified by ``key_idx`` to the given value. The ``track_idx`` must be the index of a Bezier Track. + ---- .. _class_Animation_method_clear: @@ -449,7 +495,7 @@ Returns the amount of tracks in the animation. .. _class_Animation_method_method_track_get_key_indices: -- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PackedInt32Array` **method_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const Returns all the key indices of a method track, given a position and delta time. @@ -457,7 +503,7 @@ Returns all the key indices of a method track, given a position and delta time. .. _class_Animation_method_method_track_get_name: -- :ref:`String` **method_track_get_name** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const +- :ref:`StringName` **method_track_get_name** **(** :ref:`int` track_idx, :ref:`int` key_idx **)** const Returns the method name of a method track. @@ -707,7 +753,7 @@ Returns the interpolated value of a transform track at a given time (in seconds) .. _class_Animation_method_value_track_get_key_indices: -- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PackedInt32Array` **value_track_get_key_indices** **(** :ref:`int` track_idx, :ref:`float` time_sec, :ref:`float` delta **)** const Returns all the key indices of a value track, given a position and delta time. diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index f3ec90946..b9710bcbb 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -37,43 +37,43 @@ Properties Methods ------- -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_input` **(** :ref:`String` name **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_caption` **(** **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_input_count` **(** **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter_default_value` **(** :ref:`String` name **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`has_filter` **(** **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_input` **(** :ref:`int` index **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | -+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_input` **(** :ref:`String` name **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_animation` **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`blend_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_caption` **(** **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_child_by_name` **(** :ref:`String` name **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_child_nodes` **(** **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_input_count` **(** **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`StringName` name **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_parameter_default_value` **(** :ref:`StringName` name **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_parameter_list` **(** **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_filter` **(** **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_input` **(** :ref:`int` index **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -143,7 +143,7 @@ Adds an input to the node. This is only useful for nodes created for use in an : .. _class_AnimationNode_method_blend_animation: -- void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** +- void **blend_animation** **(** :ref:`StringName` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** Blend an animation by ``blend`` amount (name must be valid in the linked :ref:`AnimationPlayer`). A ``time`` and ``delta`` may be passed, as well as whether ``seek`` happened. @@ -159,7 +159,7 @@ Blend an input. This is only useful for nodes created for an :ref:`AnimationNode .. _class_AnimationNode_method_blend_node: -- :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** +- :ref:`float` **blend_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from :ref:`AnimationRootNode` instead, else editors will not display your node for addition. @@ -207,7 +207,7 @@ Gets the name of an input by index. .. _class_AnimationNode_method_get_parameter: -- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_parameter** **(** :ref:`StringName` name **)** const Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -215,7 +215,7 @@ Gets the value of a parameter. Parameters are custom local memory used for your .. _class_AnimationNode_method_get_parameter_default_value: -- :ref:`Variant` **get_parameter_default_value** **(** :ref:`String` name **)** virtual +- :ref:`Variant` **get_parameter_default_value** **(** :ref:`StringName` name **)** virtual Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. @@ -231,7 +231,7 @@ Gets the property information for parameter. Parameters are custom local memory .. _class_AnimationNode_method_has_filter: -- :ref:`String` **has_filter** **(** **)** virtual +- :ref:`bool` **has_filter** **(** **)** virtual Returns ``true`` whether you want the blend tree editor to display filter editing on this node. @@ -275,7 +275,7 @@ Adds or removes a path for the filter. .. _class_AnimationNode_method_set_parameter: -- void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index ea63600b5..f60ff766e 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -26,19 +26,19 @@ Tutorials Properties ---------- -+-----------------------------+-------------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`animation` | ``""`` | -+-----------------------------+-------------------------------------------------------------------+--------+ ++-------------------------------------+-------------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`animation` | ``@""`` | ++-------------------------------------+-------------------------------------------------------------------+---------+ Property Descriptions --------------------- .. _class_AnimationNodeAnimation_property_animation: -- :ref:`String` **animation** +- :ref:`StringName` **animation** +-----------+----------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+----------------------+ | *Setter* | set_animation(value) | +-----------+----------------------+ diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 0ec7bbdf4..b32c843ed 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -11,7 +11,12 @@ AnimationNodeBlendTree **Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +:ref:`AnimationTree` node resource that contains many blend type nodes. +Description +----------- + +This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots. Tutorials --------- @@ -28,25 +33,25 @@ Properties Methods ------- -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_node` **(** :ref:`StringName` input_node, :ref:`int` input_index, :ref:`StringName` output_node **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`StringName` input_node, :ref:`int` input_index **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`StringName` name **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`StringName` name **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`StringName` name **)** const | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`StringName` name **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`StringName` name, :ref:`Vector2` position **)** | ++-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -63,17 +68,17 @@ Constants .. _class_AnimationNodeBlendTree_constant_CONNECTION_ERROR_CONNECTION_EXISTS: -- **CONNECTION_OK** = **0** +- **CONNECTION_OK** = **0** --- The connection was successful. -- **CONNECTION_ERROR_NO_INPUT** = **1** +- **CONNECTION_ERROR_NO_INPUT** = **1** --- The input node is ``null``. -- **CONNECTION_ERROR_NO_INPUT_INDEX** = **2** +- **CONNECTION_ERROR_NO_INPUT_INDEX** = **2** --- The specified input port is out of range. -- **CONNECTION_ERROR_NO_OUTPUT** = **3** +- **CONNECTION_ERROR_NO_OUTPUT** = **3** --- The output node is ``null``. -- **CONNECTION_ERROR_SAME_NODE** = **4** +- **CONNECTION_ERROR_SAME_NODE** = **4** --- Input and output nodes are the same. -- **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** +- **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** --- The specified connection already exists. Property Descriptions --------------------- @@ -90,58 +95,78 @@ Property Descriptions | *Getter* | get_graph_offset() | +-----------+-------------------------+ +The global offset of all sub-nodes. + Method Descriptions ------------------- .. _class_AnimationNodeBlendTree_method_add_node: -- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** + +Adds an :ref:`AnimationNode` at the given ``position``. The ``name`` is used to identify the created sub-node later. ---- .. _class_AnimationNodeBlendTree_method_connect_node: -- void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** +- void **connect_node** **(** :ref:`StringName` input_node, :ref:`int` input_index, :ref:`StringName` output_node **)** + +Connects the output of an :ref:`AnimationNode` as input for another :ref:`AnimationNode`, at the input port specified by ``input_index``. ---- .. _class_AnimationNodeBlendTree_method_disconnect_node: -- void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** +- void **disconnect_node** **(** :ref:`StringName` input_node, :ref:`int` input_index **)** + +Disconnects the node connected to the specified input. ---- .. _class_AnimationNodeBlendTree_method_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`StringName` name **)** const + +Returns the sub-node with the specified ``name``. ---- .. _class_AnimationNodeBlendTree_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`StringName` name **)** const + +Returns the position of the sub-node with the specified ``name``. ---- .. _class_AnimationNodeBlendTree_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`StringName` name **)** const + +Returns ``true`` if a sub-node with specified ``name`` exists. ---- .. _class_AnimationNodeBlendTree_method_remove_node: -- void **remove_node** **(** :ref:`String` name **)** +- void **remove_node** **(** :ref:`StringName` name **)** + +Removes a sub-node. ---- .. _class_AnimationNodeBlendTree_method_rename_node: -- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_node** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** + +Changes the name of a sub-node. ---- .. _class_AnimationNodeBlendTree_method_set_node_position: -- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`StringName` name, :ref:`Vector2` position **)** + +Modifies the position of a sub-node. diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index ad7b1b853..be8bd9c05 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -11,7 +11,12 @@ AnimationNodeOneShot **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +Plays an animation once in :ref:`AnimationNodeBlendTree`. +Description +----------- + +A resource to add to an :ref:`AnimationNodeBlendTree`. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters. Tutorials --------- @@ -74,6 +79,8 @@ Property Descriptions | *Getter* | has_autorestart() | +-----------+------------------------+ +If ``true``, the sub-animation will restart automatically after finishing. + ---- .. _class_AnimationNodeOneShot_property_autorestart_delay: @@ -88,6 +95,8 @@ Property Descriptions | *Getter* | get_autorestart_delay() | +-----------+------------------------------+ +The delay after which the automatic restart is triggered, in seconds. + ---- .. _class_AnimationNodeOneShot_property_autorestart_random_delay: @@ -102,6 +111,8 @@ Property Descriptions | *Getter* | get_autorestart_random_delay() | +-----------+-------------------------------------+ +If :ref:`autorestart` is ``true``, a random additional delay (in seconds) between 0 and this value will be added to :ref:`autorestart_delay`. + ---- .. _class_AnimationNodeOneShot_property_fadein_time: diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index 606206c12..ab5c4937d 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -11,7 +11,7 @@ AnimationNodeOutput **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +Generic output node to be added to :ref:`AnimationNodeBlendTree`. Tutorials --------- diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index eff20bfda..87489c98e 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -33,58 +33,58 @@ Tutorials Methods ------- -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_end_node` **(** **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_start_node` **(** **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_transition_count` **(** **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** const | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_node` **(** :ref:`String` name **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_graph_offset` **(** :ref:`Vector2` offset **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_start_node` **(** :ref:`String` name **)** | -+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_transition` **(** :ref:`StringName` from, :ref:`StringName` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_end_node` **(** **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_start_node` **(** **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_transition_count` **(** **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_transition` **(** :ref:`StringName` from, :ref:`StringName` to **)** const | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`StringName` name **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition` **(** :ref:`StringName` from, :ref:`StringName` to **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_node` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_node` **(** :ref:`StringName` name **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_graph_offset` **(** :ref:`Vector2` offset **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`StringName` name, :ref:`Vector2` position **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_start_node` **(** :ref:`StringName` name **)** | ++---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_AnimationNodeStateMachine_method_add_node: -- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** Adds a new node to the graph. The ``position`` is used for display in the editor. @@ -92,7 +92,7 @@ Adds a new node to the graph. The ``position`` is used for display in the editor .. _class_AnimationNodeStateMachine_method_add_transition: -- void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** +- void **add_transition** **(** :ref:`StringName` from, :ref:`StringName` to, :ref:`AnimationNodeStateMachineTransition` transition **)** Adds a transition between the given nodes. @@ -116,7 +116,7 @@ Returns the draw offset of the graph. Used for display in the editor. .. _class_AnimationNodeStateMachine_method_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`StringName` name **)** const Returns the animation node with the given name. @@ -124,7 +124,7 @@ Returns the animation node with the given name. .. _class_AnimationNodeStateMachine_method_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const +- :ref:`StringName` **get_node_name** **(** :ref:`AnimationNode` node **)** const Returns the given animation node's name. @@ -132,7 +132,7 @@ Returns the given animation node's name. .. _class_AnimationNodeStateMachine_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`StringName` name **)** const Returns the given node's coordinates. Used for display in the editor. @@ -164,7 +164,7 @@ Returns the number of connections in the graph. .. _class_AnimationNodeStateMachine_method_get_transition_from: -- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_transition_from** **(** :ref:`int` idx **)** const Returns the given transition's start node. @@ -172,7 +172,7 @@ Returns the given transition's start node. .. _class_AnimationNodeStateMachine_method_get_transition_to: -- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_transition_to** **(** :ref:`int` idx **)** const Returns the given transition's end node. @@ -180,7 +180,7 @@ Returns the given transition's end node. .. _class_AnimationNodeStateMachine_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`StringName` name **)** const Returns ``true`` if the graph contains the given node. @@ -188,7 +188,7 @@ Returns ``true`` if the graph contains the given node. .. _class_AnimationNodeStateMachine_method_has_transition: -- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const +- :ref:`bool` **has_transition** **(** :ref:`StringName` from, :ref:`StringName` to **)** const Returns ``true`` if there is a transition between the given nodes. @@ -196,7 +196,7 @@ Returns ``true`` if there is a transition between the given nodes. .. _class_AnimationNodeStateMachine_method_remove_node: -- void **remove_node** **(** :ref:`String` name **)** +- void **remove_node** **(** :ref:`StringName` name **)** Deletes the given node from the graph. @@ -204,7 +204,7 @@ Deletes the given node from the graph. .. _class_AnimationNodeStateMachine_method_remove_transition: -- void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** +- void **remove_transition** **(** :ref:`StringName` from, :ref:`StringName` to **)** Deletes the transition between the two specified nodes. @@ -220,7 +220,7 @@ Deletes the given transition by index. .. _class_AnimationNodeStateMachine_method_rename_node: -- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_node** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** Renames the given node. @@ -228,7 +228,7 @@ Renames the given node. .. _class_AnimationNodeStateMachine_method_set_end_node: -- void **set_end_node** **(** :ref:`String` name **)** +- void **set_end_node** **(** :ref:`StringName` name **)** Sets the given node as the graph end point. @@ -244,7 +244,7 @@ Sets the draw offset of the graph. Used for display in the editor. .. _class_AnimationNodeStateMachine_method_set_node_position: -- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`StringName` name, :ref:`Vector2` position **)** Sets the node's coordinates. Used for display in the editor. @@ -252,7 +252,7 @@ Sets the node's coordinates. Used for display in the editor. .. _class_AnimationNodeStateMachine_method_set_start_node: -- void **set_start_node** **(** :ref:`String` name **)** +- void **set_start_node** **(** :ref:`StringName` name **)** Sets the given node as the graph start point. diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index d1cfcdb49..4017277bf 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -40,26 +40,26 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_node` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** :ref:`String` node **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`travel` **(** :ref:`String` to_node **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_current_node` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_travel_path` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** :ref:`StringName` node **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`travel` **(** :ref:`StringName` to_node **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_AnimationNodeStateMachinePlayback_method_get_current_node: -- :ref:`String` **get_current_node** **(** **)** const +- :ref:`StringName` **get_current_node** **(** **)** const Returns the currently playing animation state. @@ -67,7 +67,7 @@ Returns the currently playing animation state. .. _class_AnimationNodeStateMachinePlayback_method_get_travel_path: -- :ref:`PoolStringArray` **get_travel_path** **(** **)** const +- :ref:`PackedStringArray` **get_travel_path** **(** **)** const Returns the current travel path as computed internally by the A\* algorithm. @@ -83,7 +83,7 @@ Returns ``true`` if an animation is playing. .. _class_AnimationNodeStateMachinePlayback_method_start: -- void **start** **(** :ref:`String` node **)** +- void **start** **(** :ref:`StringName` node **)** Starts playing the given animation. @@ -99,7 +99,7 @@ Stops the currently playing animation. .. _class_AnimationNodeStateMachinePlayback_method_travel: -- void **travel** **(** :ref:`String` to_node **)** +- void **travel** **(** :ref:`StringName` to_node **)** Transitions from the current state to another one, following the shortest path. diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 5791103cf..706cbf8c2 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -22,7 +22,7 @@ Properties ---------- +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`advance_condition` | ``""`` | +| :ref:`StringName` | :ref:`advance_condition` | ``@""`` | +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`auto_advance` | ``false`` | +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+-----------+ @@ -68,10 +68,10 @@ Property Descriptions .. _class_AnimationNodeStateMachineTransition_property_advance_condition: -- :ref:`String` **advance_condition** +- :ref:`StringName` **advance_condition** +-----------+------------------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+------------------------------+ | *Setter* | set_advance_condition(value) | +-----------+------------------------------+ diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index d818b0514..a169254cb 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -11,7 +11,12 @@ AnimationNodeTimeScale **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +A time-scaling animation node to be used with :ref:`AnimationTree`. +Description +----------- + +Allows scaling the speed of the animation (or reversing it) in any children nodes. Setting it to 0 will pause the animation. Tutorials --------- diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index dc6888746..94ed1abac 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -11,7 +11,12 @@ AnimationNodeTimeSeek **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +A time-seeking animation node to be used with :ref:`AnimationTree`. +Description +----------- + +This node can be used to cause a seek command to happen to any sub-children of the graph. After setting the time, this value returns to -1. Tutorials --------- diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 393192a9e..4878bc86c 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -11,7 +11,12 @@ AnimationNodeTransition **Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +A generic animation transition node for :ref:`AnimationTree`. +Description +----------- + +Simple state machine for cases which don't require a more advanced :ref:`AnimationNodeStateMachine`. Animations can be connected to the inputs and transition times can be specified. Tutorials --------- @@ -55,6 +60,8 @@ Property Descriptions | *Getter* | get_enabled_inputs() | +-----------+---------------------------+ +The number of available input ports for this node. + ---- .. _class_AnimationNodeTransition_property_xfade_time: @@ -69,6 +76,8 @@ Property Descriptions | *Getter* | get_cross_fade_time() | +-----------+----------------------------+ +Cross-fading time (in seconds) between each animation connected to the inputs. + Method Descriptions ------------------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index e9d800c11..de7242b28 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -18,6 +18,8 @@ Description An animation player is used for general-purpose playback of :ref:`Animation` resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. +``AnimationPlayer`` is more suited than :ref:`Tween` for animations where you know the final values in advance. For example, fading a screen in and out is more easily done with an ``AnimationPlayer`` node thanks to the animation tools provided by the editor. That particular example can also be implemented with a :ref:`Tween` node, but it requires doing everything by code. + Updating the target properties of animations occurs at process time. Tutorials @@ -57,58 +59,58 @@ Properties Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_caches` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_queue` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playing_speed` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_queue` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`add_animation` **(** :ref:`StringName` name, :ref:`Animation` animation **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`advance` **(** :ref:`float` delta **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`animation_get_next` **(** :ref:`StringName` anim_from **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`animation_set_next` **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_caches` **(** **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_queue` **(** **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_animation_list` **(** **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playing_speed` **(** **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_queue` **(** **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play_backwards` **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1 **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue` **(** :ref:`StringName` name **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`StringName` name **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`StringName` name, :ref:`StringName` newname **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_time` **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to, :ref:`float` sec **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`bool` reset=true **)** | ++---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_AnimationPlayer_signal_animation_changed: -- **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +- **animation_changed** **(** :ref:`StringName` old_name, :ref:`StringName` new_name **)** If the currently being played animation changes, this signal will notify of such change. @@ -116,7 +118,7 @@ If the currently being played animation changes, this signal will notify of such .. _class_AnimationPlayer_signal_animation_finished: -- **animation_finished** **(** :ref:`String` anim_name **)** +- **animation_finished** **(** :ref:`StringName` anim_name **)** Notifies when an animation finished playing. @@ -124,7 +126,7 @@ Notifies when an animation finished playing. .. _class_AnimationPlayer_signal_animation_started: -- **animation_started** **(** :ref:`String` anim_name **)** +- **animation_started** **(** :ref:`StringName` anim_name **)** Notifies when an animation starts playing. @@ -339,7 +341,7 @@ Method Descriptions .. _class_AnimationPlayer_method_add_animation: -- :ref:`Error` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** +- :ref:`Error` **add_animation** **(** :ref:`StringName` name, :ref:`Animation` animation **)** Adds ``animation`` to the player accessible with the key ``name``. @@ -355,7 +357,7 @@ Shifts position in the animation timeline and immediately updates the animation. .. _class_AnimationPlayer_method_animation_get_next: -- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const +- :ref:`StringName` **animation_get_next** **(** :ref:`StringName` anim_from **)** const Returns the name of the next animation in the queue. @@ -363,7 +365,7 @@ Returns the name of the next animation in the queue. .. _class_AnimationPlayer_method_animation_set_next: -- void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** +- void **animation_set_next** **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to **)** Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. @@ -387,7 +389,7 @@ Clears all queued, unplayed animations. .. _class_AnimationPlayer_method_find_animation: -- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const +- :ref:`StringName` **find_animation** **(** :ref:`Animation` animation **)** const Returns the name of ``animation`` or an empty string if not found. @@ -395,7 +397,7 @@ Returns the name of ``animation`` or an empty string if not found. .. _class_AnimationPlayer_method_get_animation: -- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const +- :ref:`Animation` **get_animation** **(** :ref:`StringName` name **)** const Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. @@ -403,7 +405,7 @@ Returns the :ref:`Animation` with key ``name`` or ``null`` if n .. _class_AnimationPlayer_method_get_animation_list: -- :ref:`PoolStringArray` **get_animation_list** **(** **)** const +- :ref:`PackedStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. @@ -411,7 +413,7 @@ Returns the list of stored animation names. .. _class_AnimationPlayer_method_get_blend_time: -- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const +- :ref:`float` **get_blend_time** **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to **)** const Gets the blend time (in seconds) between two animations, referenced by their names. @@ -427,7 +429,7 @@ Gets the actual playing speed of current animation or 0 if not playing. This spe .. _class_AnimationPlayer_method_get_queue: -- :ref:`PoolStringArray` **get_queue** **(** **)** +- :ref:`PackedStringArray` **get_queue** **(** **)** Returns a list of the animation names that are currently queued to play. @@ -435,7 +437,7 @@ Returns a list of the animation names that are currently queued to play. .. _class_AnimationPlayer_method_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const +- :ref:`bool` **has_animation** **(** :ref:`StringName` name **)** const Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. @@ -451,7 +453,7 @@ Returns ``true`` if playing an animation. .. _class_AnimationPlayer_method_play: -- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +- void **play** **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** Plays the animation with key ``name``. Custom blend times and speed can be set. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards`). @@ -463,7 +465,7 @@ The ``AnimationPlayer`` keeps track of its current or last played animation with .. _class_AnimationPlayer_method_play_backwards: -- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** +- void **play_backwards** **(** :ref:`StringName` name="", :ref:`float` custom_blend=-1 **)** Plays the animation with key ``name`` in reverse. @@ -473,7 +475,7 @@ This method is a shorthand for :ref:`play` wi .. _class_AnimationPlayer_method_queue: -- void **queue** **(** :ref:`String` name **)** +- void **queue** **(** :ref:`StringName` name **)** Queues an animation for playback once the current one is done. @@ -483,7 +485,7 @@ Queues an animation for playback once the current one is done. .. _class_AnimationPlayer_method_remove_animation: -- void **remove_animation** **(** :ref:`String` name **)** +- void **remove_animation** **(** :ref:`StringName` name **)** Removes the animation with key ``name``. @@ -491,7 +493,7 @@ Removes the animation with key ``name``. .. _class_AnimationPlayer_method_rename_animation: -- void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`StringName` name, :ref:`StringName` newname **)** Renames an existing animation with key ``name`` to ``newname``. @@ -507,7 +509,7 @@ Seeks the animation to the ``seconds`` point in time (in seconds). If ``update`` .. _class_AnimationPlayer_method_set_blend_time: -- void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** +- void **set_blend_time** **(** :ref:`StringName` anim_from, :ref:`StringName` anim_to, :ref:`float` sec **)** Specifies a blend time (in seconds) between two animations, referenced by their names. diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 95ad6051c..a8c667683 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -11,7 +11,7 @@ AnimationTree **Inherits:** :ref:`Node` **<** :ref:`Object` - +A node to be used for advanced animation transitions in an :ref:`AnimationPlayer`. Tutorials --------- @@ -59,11 +59,11 @@ Enumerations enum **AnimationProcessMode**: -- **ANIMATION_PROCESS_PHYSICS** = **0** +- **ANIMATION_PROCESS_PHYSICS** = **0** --- The animations will progress during the physics frame (i.e. :ref:`Node._physics_process`). -- **ANIMATION_PROCESS_IDLE** = **1** +- **ANIMATION_PROCESS_IDLE** = **1** --- The animations will progress during the idle frame (i.e. :ref:`Node._process`). -- **ANIMATION_PROCESS_MANUAL** = **2** +- **ANIMATION_PROCESS_MANUAL** = **2** --- The animations will only progress manually (see :ref:`advance`). Property Descriptions --------------------- @@ -80,6 +80,8 @@ Property Descriptions | *Getter* | is_active() | +-----------+-------------------+ +If ``true``, the ``AnimationTree`` will be processing. + ---- .. _class_AnimationTree_property_anim_player: @@ -94,6 +96,8 @@ Property Descriptions | *Getter* | get_animation_player() | +-----------+-----------------------------+ +The path to the :ref:`AnimationPlayer` used for animating. + ---- .. _class_AnimationTree_property_process_mode: @@ -108,6 +112,8 @@ Property Descriptions | *Getter* | get_process_mode() | +-----------+-------------------------+ +The process mode of this ``AnimationTree``. See :ref:`AnimationProcessMode` for available modes. + ---- .. _class_AnimationTree_property_root_motion_track: @@ -134,6 +140,8 @@ Property Descriptions | *Getter* | get_tree_root() | +----------+----------------------+ +The root animation node of this ``AnimationTree``. See :ref:`AnimationNode`. + Method Descriptions ------------------- @@ -141,6 +149,8 @@ Method Descriptions - void **advance** **(** :ref:`float` delta **)** +Manually advance the animations by the specified time (in seconds). + ---- .. _class_AnimationTree_method_get_root_motion_transform: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst deleted file mode 100644 index d3cb5497c..000000000 --- a/classes/class_animationtreeplayer.rst +++ /dev/null @@ -1,766 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_AnimationTreePlayer: - -AnimationTreePlayer -=================== - -**Inherits:** :ref:`Node` **<** :ref:`Object` - -Animation player that uses a node graph for blending animations. - -Description ------------ - -A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. - -It takes :ref:`Animation`\ s from an :ref:`AnimationPlayer` node and mixes them depending on the graph. - -Tutorials ---------- - -- :doc:`../tutorials/animation/animation_tree` - -Properties ----------- - -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+ -| :ref:`bool` | :ref:`active` | ``false`` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+ -| :ref:`NodePath` | :ref:`base_path` | ``NodePath("..")`` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+ -| :ref:`NodePath` | :ref:`master_player` | ``NodePath("")`` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+ -| :ref:`AnimationProcessMode` | :ref:`playback_process_mode` | ``1`` | -+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+--------------------+ - -Methods -------- - -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`NodeType` type, :ref:`String` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`advance` **(** :ref:`float` delta **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`animation_node_get_position` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodeType` | :ref:`node_get_type` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`recompute_caches` **(** **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` id **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | -+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_AnimationTreePlayer_NodeType: - -.. _class_AnimationTreePlayer_constant_NODE_OUTPUT: - -.. _class_AnimationTreePlayer_constant_NODE_ANIMATION: - -.. _class_AnimationTreePlayer_constant_NODE_ONESHOT: - -.. _class_AnimationTreePlayer_constant_NODE_MIX: - -.. _class_AnimationTreePlayer_constant_NODE_BLEND2: - -.. _class_AnimationTreePlayer_constant_NODE_BLEND3: - -.. _class_AnimationTreePlayer_constant_NODE_BLEND4: - -.. _class_AnimationTreePlayer_constant_NODE_TIMESCALE: - -.. _class_AnimationTreePlayer_constant_NODE_TIMESEEK: - -.. _class_AnimationTreePlayer_constant_NODE_TRANSITION: - -enum **NodeType**: - -- **NODE_OUTPUT** = **0** --- Output node. - -- **NODE_ANIMATION** = **1** --- Animation node. - -- **NODE_ONESHOT** = **2** --- OneShot node. - -- **NODE_MIX** = **3** --- Mix node. - -- **NODE_BLEND2** = **4** --- Blend2 node. - -- **NODE_BLEND3** = **5** --- Blend3 node. - -- **NODE_BLEND4** = **6** --- Blend4 node. - -- **NODE_TIMESCALE** = **7** --- TimeScale node. - -- **NODE_TIMESEEK** = **8** --- TimeSeek node. - -- **NODE_TRANSITION** = **9** --- Transition node. - ----- - -.. _enum_AnimationTreePlayer_AnimationProcessMode: - -.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_PHYSICS: - -.. _class_AnimationTreePlayer_constant_ANIMATION_PROCESS_IDLE: - -enum **AnimationProcessMode**: - -- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. - -- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. - -Property Descriptions ---------------------- - -.. _class_AnimationTreePlayer_property_active: - -- :ref:`bool` **active** - -+-----------+-------------------+ -| *Default* | ``false`` | -+-----------+-------------------+ -| *Setter* | set_active(value) | -+-----------+-------------------+ -| *Getter* | is_active() | -+-----------+-------------------+ - -If ``true``, the ``AnimationTreePlayer`` is able to play animations. - ----- - -.. _class_AnimationTreePlayer_property_base_path: - -- :ref:`NodePath` **base_path** - -+-----------+----------------------+ -| *Default* | ``NodePath("..")`` | -+-----------+----------------------+ -| *Setter* | set_base_path(value) | -+-----------+----------------------+ -| *Getter* | get_base_path() | -+-----------+----------------------+ - -The node from which to relatively access other nodes. - -It accesses the bones, so it should point to the same node the :ref:`AnimationPlayer` would point its Root Node at. - ----- - -.. _class_AnimationTreePlayer_property_master_player: - -- :ref:`NodePath` **master_player** - -+-----------+--------------------------+ -| *Default* | ``NodePath("")`` | -+-----------+--------------------------+ -| *Setter* | set_master_player(value) | -+-----------+--------------------------+ -| *Getter* | get_master_player() | -+-----------+--------------------------+ - -The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. - -Once set, :ref:`Animation` nodes can be added to the ``AnimationTreePlayer``. - ----- - -.. _class_AnimationTreePlayer_property_playback_process_mode: - -- :ref:`AnimationProcessMode` **playback_process_mode** - -+-----------+-----------------------------------+ -| *Default* | ``1`` | -+-----------+-----------------------------------+ -| *Setter* | set_animation_process_mode(value) | -+-----------+-----------------------------------+ -| *Getter* | get_animation_process_mode() | -+-----------+-----------------------------------+ - -The thread in which to update animations. - -Method Descriptions -------------------- - -.. _class_AnimationTreePlayer_method_add_node: - -- void **add_node** **(** :ref:`NodeType` type, :ref:`String` id **)** - -Adds a ``type`` node to the graph with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_advance: - -- void **advance** **(** :ref:`float` delta **)** - -Shifts position in the animation timeline. ``delta`` is the time in seconds to shift. Events between the current frame and ``delta`` are handled. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_get_animation: - -- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const - -Returns the :ref:`AnimationPlayer`'s :ref:`Animation` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_get_master_animation: - -- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const - -Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_get_position: - -- :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const - -Returns the absolute playback timestamp of the animation node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_set_animation: - -- void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** - -Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_set_filter_path: - -- void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** - -If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. - ----- - -.. _class_AnimationTreePlayer_method_animation_node_set_master_animation: - -- void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** - -Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. - ----- - -.. _class_AnimationTreePlayer_method_are_nodes_connected: - -- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const - -Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. - ----- - -.. _class_AnimationTreePlayer_method_blend2_node_get_amount: - -- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const - -Returns the blend amount of a Blend2 node given its name. - ----- - -.. _class_AnimationTreePlayer_method_blend2_node_set_amount: - -- void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** - -Sets the blend amount of a Blend2 node given its name and value. - -A Blend2 node blends two animations (A and B) with the amount between 0 and 1. - -At 0, output is input A. Towards 1, the influence of A gets lessened, the influence of B gets raised. At 1, output is input B. - ----- - -.. _class_AnimationTreePlayer_method_blend2_node_set_filter_path: - -- void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** - -If ``enable`` is ``true``, the Blend2 node with name ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. - ----- - -.. _class_AnimationTreePlayer_method_blend3_node_get_amount: - -- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const - -Returns the blend amount of a Blend3 node given its name. - ----- - -.. _class_AnimationTreePlayer_method_blend3_node_set_amount: - -- void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** - -Sets the blend amount of a Blend3 node given its name and value. - -A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1. - -At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the influence of A gets raised and the influence of B+ is 0. At 0, output is input A. From 0 to 1, the influence of A gets lessened, the influence of B+ gets raised and the influence of B+ is 0. At 1, output is input B+. - ----- - -.. _class_AnimationTreePlayer_method_blend4_node_get_amount: - -- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const - -Returns the blend amount of a Blend4 node given its name. - ----- - -.. _class_AnimationTreePlayer_method_blend4_node_set_amount: - -- void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** - -Sets the blend amount of a Blend4 node given its name and value. - -A Blend4 Node blends two pairs of animations. - -The two pairs are blended like Blend2 and then added together. - ----- - -.. _class_AnimationTreePlayer_method_connect_nodes: - -- :ref:`Error` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** - -Connects node ``id`` to ``dst_id`` at the specified input slot. - ----- - -.. _class_AnimationTreePlayer_method_disconnect_nodes: - -- void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** - -Disconnects nodes connected to ``id`` at the specified input slot. - ----- - -.. _class_AnimationTreePlayer_method_get_node_list: - -- :ref:`PoolStringArray` **get_node_list** **(** **)** - -Returns a :ref:`PoolStringArray` containing the name of all nodes. - ----- - -.. _class_AnimationTreePlayer_method_mix_node_get_amount: - -- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const - -Returns the mix amount of a Mix node given its name. - ----- - -.. _class_AnimationTreePlayer_method_mix_node_set_amount: - -- void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** - -Sets the mix amount of a Mix node given its name and value. - -A Mix node adds input b to input a by the amount given by ratio. - ----- - -.. _class_AnimationTreePlayer_method_node_exists: - -- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const - -Check if a node exists (by name). - ----- - -.. _class_AnimationTreePlayer_method_node_get_input_count: - -- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const - -Returns the input count for a given node. Different types of nodes have different amount of inputs. - ----- - -.. _class_AnimationTreePlayer_method_node_get_input_source: - -- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const - -Returns the input source for a given node input. - ----- - -.. _class_AnimationTreePlayer_method_node_get_position: - -- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const - -Returns position of a node in the graph given its name. - ----- - -.. _class_AnimationTreePlayer_method_node_get_type: - -- :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const - -Gets the node type, will return from :ref:`NodeType` enum. - ----- - -.. _class_AnimationTreePlayer_method_node_rename: - -- :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** - -Renames a node in the graph. - ----- - -.. _class_AnimationTreePlayer_method_node_set_position: - -- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** - -Sets the position of a node in the graph given its name and position. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_delay: - -- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const - -Returns the autostart delay of a OneShot node given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_get_autorestart_random_delay: - -- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const - -Returns the autostart random delay of a OneShot node given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_get_fadein_time: - -- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const - -Returns the fade in time of a OneShot node given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_get_fadeout_time: - -- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const - -Returns the fade out time of a OneShot node given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_has_autorestart: - -- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const - -Returns whether a OneShot node will auto restart given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_is_active: - -- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const - -Returns whether a OneShot node is active given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart: - -- void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** - -Sets the autorestart property of a OneShot node given its name and value. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_delay: - -- void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** - -Sets the autorestart delay of a OneShot node given its name and value in seconds. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_autorestart_random_delay: - -- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** - -Sets the autorestart random delay of a OneShot node given its name and value in seconds. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_fadein_time: - -- void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** - -Sets the fade in time of a OneShot node given its name and value in seconds. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_fadeout_time: - -- void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** - -Sets the fade out time of a OneShot node given its name and value in seconds. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_set_filter_path: - -- void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** - -If ``enable`` is ``true``, the OneShot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_start: - -- void **oneshot_node_start** **(** :ref:`String` id **)** - -Starts a OneShot node given its name. - ----- - -.. _class_AnimationTreePlayer_method_oneshot_node_stop: - -- void **oneshot_node_stop** **(** :ref:`String` id **)** - -Stops the OneShot node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_recompute_caches: - -- void **recompute_caches** **(** **)** - -Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. - ----- - -.. _class_AnimationTreePlayer_method_remove_node: - -- void **remove_node** **(** :ref:`String` id **)** - -Removes the animation node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_reset: - -- void **reset** **(** **)** - -Resets this ``AnimationTreePlayer``. - ----- - -.. _class_AnimationTreePlayer_method_timescale_node_get_scale: - -- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const - -Returns the time scale value of the TimeScale node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_timescale_node_set_scale: - -- void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** - -Sets the time scale of the TimeScale node with name ``id`` to ``scale``. - -The TimeScale node is used to speed :ref:`Animation`\ s up if the scale is above 1 or slow them down if it is below 1. - -If applied after a blend or mix, affects all input animations to that blend or mix. - ----- - -.. _class_AnimationTreePlayer_method_timeseek_node_seek: - -- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** - -Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``. - -This functions as a seek in the :ref:`Animation` or the blend or mix of :ref:`Animation`\ s input in it. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_delete_input: - -- void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** - -Deletes the input at ``input_idx`` for the transition node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_get_current: - -- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const - -Returns the index of the currently evaluated input for the transition node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_get_input_count: - -- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const - -Returns the number of inputs for the transition node with name ``id``. You can add inputs by right-clicking on the transition node. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_get_xfade_time: - -- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const - -Returns the cross fade time for the transition node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_has_input_auto_advance: - -- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const - -Returns ``true`` if the input at ``input_idx`` on the transition node with name ``id`` is set to automatically advance to the next input upon completion. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_set_current: - -- void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** - -The transition node with name ``id`` sets its current input at ``input_idx``. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_set_input_auto_advance: - -- void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** - -The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_set_input_count: - -- void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** - -Resizes the number of inputs available for the transition node with name ``id``. - ----- - -.. _class_AnimationTreePlayer_method_transition_node_set_xfade_time: - -- void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** - -The transition node with name ``id`` sets its cross fade time to ``time_sec``. - diff --git a/classes/class_area.rst b/classes/class_area.rst index 381d5dd05..d70ee938e 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -24,7 +24,7 @@ Properties +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`angular_damp` | ``0.1`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`String` | :ref:`audio_bus_name` | ``"Master"`` | +| :ref:`StringName` | :ref:`audio_bus_name` | ``@"Master"`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`audio_bus_override` | ``false`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ @@ -52,7 +52,7 @@ Properties +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`reverb_bus_enable` | ``false`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`String` | :ref:`reverb_bus_name` | ``"Master"`` | +| :ref:`StringName` | :ref:`reverb_bus_name` | ``@"Master"`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`reverb_bus_uniformity` | ``0.0`` | +-----------------------------------------------+---------------------------------------------------------------------------+-------------------------+ @@ -201,10 +201,10 @@ The rate at which objects stop spinning in this area. Represents the angular vel .. _class_Area_property_audio_bus_name: -- :ref:`String` **audio_bus_name** +- :ref:`StringName` **audio_bus_name** +-----------+----------------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+----------------------+ | *Setter* | set_audio_bus(value) | +-----------+----------------------+ @@ -425,10 +425,10 @@ If ``true``, the area applies reverb to its associated audio. .. _class_Area_property_reverb_bus_name: -- :ref:`String` **reverb_bus_name** +- :ref:`StringName` **reverb_bus_name** +-----------+-----------------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+-----------------------+ | *Setter* | set_reverb_bus(value) | +-----------+-----------------------+ diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 1d128a047..2c04f52d1 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -29,7 +29,7 @@ Properties +-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`angular_damp` | ``1.0`` | +-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`audio_bus_name` | ``"Master"`` | +| :ref:`StringName` | :ref:`audio_bus_name` | ``@"Master"`` | +-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`audio_bus_override` | ``false`` | +-------------------------------------------------+-----------------------------------------------------------------------------+---------------------+ @@ -198,10 +198,10 @@ The rate at which objects stop spinning in this area. Represents the angular vel .. _class_Area2D_property_audio_bus_name: -- :ref:`String` **audio_bus_name** +- :ref:`StringName` **audio_bus_name** +-----------+---------------------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+---------------------------+ | *Setter* | set_audio_bus_name(value) | +-----------+---------------------------+ diff --git a/classes/class_array.rst b/classes/class_array.rst index 2f4a7590f..b144711a4 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -27,131 +27,155 @@ Generic array which can contain several elements of any type, accessible by a nu array[2] = "Three" print(array[-2]) # Three. +Arrays can be concatenated using the ``+`` operator: + +:: + + var array1 = ["One", 2] + var array2 = [3, "Four"] + print(array1 + array2) # ["One", 2, 3, "Four"] + Arrays are always passed by reference. Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`back` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=True **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`front` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`max` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`min` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`pop_back` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`pop_front` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** :ref:`Variant` value **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` position **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shuffle` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=False **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedColorArray` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector3Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedVector2Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedStringArray` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat64Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedFloat32Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt64Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedInt32Array` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PackedByteArray` from **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`back` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=true **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=true **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`front` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`max` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`min` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_back` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop_front` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** :ref:`Variant` value **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` position **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shuffle` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`slice` **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=false **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Array_method_Array: -- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedColorArray` from **)** -Constructs an array from a :ref:`PoolColorArray`. +Constructs an array from a :ref:`PackedColorArray`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedVector3Array` from **)** -Constructs an array from a :ref:`PoolVector3Array`. +Constructs an array from a :ref:`PackedVector3Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedVector2Array` from **)** -Constructs an array from a :ref:`PoolVector2Array`. +Constructs an array from a :ref:`PackedVector2Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedStringArray` from **)** -Constructs an array from a :ref:`PoolStringArray`. +Constructs an array from a :ref:`PackedStringArray`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedFloat64Array` from **)** -Constructs an array from a :ref:`PoolRealArray`. +Constructs an array from a :ref:`PackedFloat64Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedFloat32Array` from **)** -Constructs an array from a :ref:`PoolIntArray`. +Constructs an array from a :ref:`PackedFloat32Array`. ---- -- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PackedInt64Array` from **)** -Constructs an array from a :ref:`PoolByteArray`. +Constructs an array from a :ref:`PackedInt64Array`. + +---- + +- :ref:`Array` **Array** **(** :ref:`PackedInt32Array` from **)** + +Constructs an array from a :ref:`PackedInt32Array`. + +---- + +- :ref:`Array` **Array** **(** :ref:`PackedByteArray` from **)** + +Constructs an array from a :ref:`PackedByteArray`. ---- @@ -165,7 +189,7 @@ Appends an element at the end of the array (alias of :ref:`push_back` **back** **(** **)** +- void **back** **(** **)** Returns the last element of the array, or ``null`` if the array is empty. @@ -173,7 +197,7 @@ Returns the last element of the array, or ``null`` if the array is empty. .. _class_Array_method_bsearch: -- :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=True **)** +- :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=true **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. @@ -183,7 +207,7 @@ Finds the index of an existing value (or the insertion index that maintains sort .. _class_Array_method_bsearch_custom: -- :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** +- :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=true **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. @@ -209,7 +233,7 @@ Returns the number of times an element is in the array. .. _class_Array_method_duplicate: -- :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** +- :ref:`Array` **duplicate** **(** :ref:`bool` deep=false **)** Returns a copy of the array. @@ -251,7 +275,7 @@ Searches the array in reverse order for a value and returns its index or -1 if n .. _class_Array_method_front: -- :ref:`Variant` **front** **(** **)** +- void **front** **(** **)** Returns the first element of the array, or ``null`` if the array is empty. @@ -298,7 +322,7 @@ Reverses the order of the elements in the array. .. _class_Array_method_max: -- :ref:`Variant` **max** **(** **)** +- void **max** **(** **)** Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -306,7 +330,7 @@ Returns the maximum value contained in the array if all elements are of comparab .. _class_Array_method_min: -- :ref:`Variant` **min** **(** **)** +- void **min** **(** **)** Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. @@ -314,7 +338,7 @@ Returns the minimum value contained in the array if all elements are of comparab .. _class_Array_method_pop_back: -- :ref:`Variant` **pop_back** **(** **)** +- void **pop_back** **(** **)** Removes and returns the last element of the array. Returns ``null`` if the array is empty. @@ -322,7 +346,7 @@ Removes and returns the last element of the array. Returns ``null`` if the array .. _class_Array_method_pop_front: -- :ref:`Variant` **pop_front** **(** **)** +- void **pop_front** **(** **)** Removes and returns the first element of the array. Returns ``null`` if the array is empty. @@ -386,7 +410,7 @@ Returns the number of elements in the array. .. _class_Array_method_slice: -- :ref:`Array` **slice** **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=False **)** +- :ref:`Array` **slice** **(** :ref:`int` begin, :ref:`int` end, :ref:`int` step=1, :ref:`bool` deep=false **)** Duplicates the subset described in the function and returns it in an array, deeply copying the array if ``deep`` is ``true``. Lower and upper index are inclusive, with the ``step`` describing the change between indices while slicing. @@ -398,7 +422,13 @@ Duplicates the subset described in the function and returns it in an array, deep Sorts the array. -**Note:** strings are sorted in alphabetical, not natural order. +**Note:** Strings are sorted in alphabetical order (as opposed to natural order). This may lead to unexpected behavior when sorting an array of strings ending with a sequence of numbers. Consider the following example: + +:: + + var strings = ["string1", "string2", "string10", "string11"] + strings.sort() + print(strings) # Prints [string1, string10, string11, string2] ---- diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 6697adfe6..7c595788a 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -22,7 +22,7 @@ The most basic example is the creation of a single triangle: :: - var vertices = PoolVector3Array() + var vertices = PackedVector3Array() vertices.push_back(Vector3(0, 1, 0)) vertices.push_back(Vector3(1, 0, 0)) vertices.push_back(Vector3(0, 0, 1)) @@ -55,39 +55,39 @@ Properties Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`StringName` name **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`Dictionary` lods={ }, :ref:`int` compress_flags=31744 **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_surfaces` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -116,23 +116,23 @@ Enumerations enum **ArrayType**: -- **ARRAY_VERTEX** = **0** --- :ref:`PoolVector3Array`, :ref:`PoolVector2Array`, or :ref:`Array` of vertex positions. +- **ARRAY_VERTEX** = **0** --- :ref:`PackedVector3Array`, :ref:`PackedVector2Array`, or :ref:`Array` of vertex positions. -- **ARRAY_NORMAL** = **1** --- :ref:`PoolVector3Array` of vertex normals. +- **ARRAY_NORMAL** = **1** --- :ref:`PackedVector3Array` of vertex normals. -- **ARRAY_TANGENT** = **2** --- :ref:`PoolRealArray` of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. +- **ARRAY_TANGENT** = **2** --- :ref:`PackedFloat32Array` of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. -- **ARRAY_COLOR** = **3** --- :ref:`PoolColorArray` of vertex colors. +- **ARRAY_COLOR** = **3** --- :ref:`PackedColorArray` of vertex colors. -- **ARRAY_TEX_UV** = **4** --- :ref:`PoolVector2Array` for UV coordinates. +- **ARRAY_TEX_UV** = **4** --- :ref:`PackedVector2Array` for UV coordinates. -- **ARRAY_TEX_UV2** = **5** --- :ref:`PoolVector2Array` for second UV coordinates. +- **ARRAY_TEX_UV2** = **5** --- :ref:`PackedVector2Array` for second UV coordinates. -- **ARRAY_BONES** = **6** --- :ref:`PoolRealArray` or :ref:`PoolIntArray` of bone indices. Each element in groups of 4 floats. +- **ARRAY_BONES** = **6** --- :ref:`PackedFloat32Array` or :ref:`PackedInt32Array` of bone indices. Each element in groups of 4 floats. -- **ARRAY_WEIGHTS** = **7** --- :ref:`PoolRealArray` of bone weights. Each element in groups of 4 floats. +- **ARRAY_WEIGHTS** = **7** --- :ref:`PackedFloat32Array` of bone weights. Each element in groups of 4 floats. -- **ARRAY_INDEX** = **8** --- :ref:`PoolIntArray` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. +- **ARRAY_INDEX** = **8** --- :ref:`PackedInt32Array` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. @@ -229,7 +229,7 @@ Method Descriptions .. _class_ArrayMesh_method_add_blend_shape: -- void **add_blend_shape** **(** :ref:`String` name **)** +- void **add_blend_shape** **(** :ref:`StringName` name **)** Adds name for a blend shape that will be added with :ref:`add_surface_from_arrays`. Must be called before surface is added. @@ -237,7 +237,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface_from_array .. _class_ArrayMesh_method_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** +- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`Dictionary` lods={ }, :ref:`int` compress_flags=31744 **)** Creates a new surface. @@ -259,6 +259,14 @@ Removes all blend shapes from this ``ArrayMesh``. ---- +.. _class_ArrayMesh_method_clear_surfaces: + +- void **clear_surfaces** **(** **)** + +Removes all surfaces from this ``ArrayMesh``. + +---- + .. _class_ArrayMesh_method_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const @@ -269,7 +277,7 @@ Returns the number of blend shapes that the ``ArrayMesh`` holds. .. _class_ArrayMesh_method_get_blend_shape_name: -- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const +- :ref:`StringName` **get_blend_shape_name** **(** :ref:`int` index **)** const Returns the name of the blend shape at this index. @@ -339,14 +347,6 @@ Returns the primitive type of the requested surface (see :ref:`add_surface_from_ ---- -.. _class_ArrayMesh_method_surface_remove: - -- void **surface_remove** **(** :ref:`int` surf_idx **)** - -Removes a surface at position ``surf_idx``, shifting greater surfaces one ``surf_idx`` slot down. - ----- - .. _class_ArrayMesh_method_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** @@ -357,7 +357,7 @@ Sets a name for a given surface. .. _class_ArrayMesh_method_surface_update_region: -- void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** +- void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** Updates a specified region of mesh arrays on the GPU. diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 02526a4a1..355539aca 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -52,7 +52,7 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | +| :ref:`bool` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Signals @@ -174,7 +174,7 @@ If provided by the :ref:`ARVRInterface`, this returns a mes .. _class_ARVRController_method_is_button_pressed: -- :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const +- :ref:`bool` **is_button_pressed** **(** :ref:`int` button **)** const Returns ``true`` if the button at index ``button`` is pressed. See :ref:`JoystickList`, in particular the ``JOY_VR_*`` constants. diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 50b546c27..ef54dc151 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -46,7 +46,7 @@ Methods +------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_capabilities` **(** **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`StringName` | :ref:`get_name` **(** **)** const | +------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | +------------------------------------------------------------+----------------------------------------------------------------------------------------------+ @@ -200,7 +200,7 @@ Returns a combination of :ref:`Capabilities` fl .. _class_ARVRInterface_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`StringName` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 99d2cfdc3..62f1e5a75 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -44,12 +44,14 @@ Methods +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`StringName` | :ref:`get_name` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`get_orientation` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_position` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tracker_id` **(** **)** const | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | @@ -124,7 +126,7 @@ Returns the mesh related to a controller or anchor point if one is available. .. _class_ARVRPositionalTracker_method_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`StringName` **get_name** **(** **)** const Returns the controller or anchor point's name if available. @@ -146,6 +148,14 @@ Returns the world-space controller position. ---- +.. _class_ARVRPositionalTracker_method_get_tracker_id: + +- :ref:`int` **get_tracker_id** **(** **)** const + +Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the :ref:`ARVRController` and :ref:`ARVRAnchor` nodes. + +---- + .. _class_ARVRPositionalTracker_method_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index eb937d617..a3ff58bad 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -66,7 +66,7 @@ Signals .. _class_ARVRServer_signal_interface_added: -- **interface_added** **(** :ref:`String` interface_name **)** +- **interface_added** **(** :ref:`StringName` interface_name **)** Emitted when a new interface has been added. @@ -74,7 +74,7 @@ Emitted when a new interface has been added. .. _class_ARVRServer_signal_interface_removed: -- **interface_removed** **(** :ref:`String` interface_name **)** +- **interface_removed** **(** :ref:`StringName` interface_name **)** Emitted when an interface is removed. @@ -82,7 +82,7 @@ Emitted when an interface is removed. .. _class_ARVRServer_signal_tracker_added: -- **tracker_added** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_added** **(** :ref:`StringName` tracker_name, :ref:`int` type, :ref:`int` id **)** Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using :ref:`ARVRAnchor`\ s for an AR solution, it is important to react to this signal to add the appropriate :ref:`ARVRController` or :ref:`ARVRAnchor` nodes related to this new tracker. @@ -90,7 +90,7 @@ Emitted when a new tracker has been added. If you don't use a fixed number of co .. _class_ARVRServer_signal_tracker_removed: -- **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_removed** **(** :ref:`StringName` tracker_name, :ref:`int` type, :ref:`int` id **)** Emitted when a tracker is removed. You should remove any :ref:`ARVRController` or :ref:`ARVRAnchor` points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 6c55e5f2d..f7bd4c333 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -38,57 +38,57 @@ It is also possible to use non-Euclidean distances. To do so, create a class tha Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position, :ref:`bool` include_disabled=false **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -203,7 +203,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. _class_AStar_method_get_id_path: -- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PackedInt32Array` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. @@ -236,7 +236,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. _class_AStar_method_get_point_connections: -- :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** +- :ref:`PackedInt32Array` **get_point_connections** **(** :ref:`int` id **)** Returns an array with the IDs of the points that form the connection with the given point. @@ -265,7 +265,7 @@ Returns the number of points currently in the points pool. .. _class_AStar_method_get_point_path: -- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PackedVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. diff --git a/classes/class_astar2d.rst b/classes/class_astar2d.rst index 568ae48d2..8d6c911c5 100644 --- a/classes/class_astar2d.rst +++ b/classes/class_astar2d.rst @@ -21,53 +21,53 @@ This is a wrapper for the :ref:`AStar` class which uses 2D vectors Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector2` position, :ref:`float` weight_scale=1.0 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector2` to_position, :ref:`bool` include_disabled=false **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector2` to_position **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_capacity` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_point_connections` **(** :ref:`int` id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reserve_space` **(** :ref:`int` num_nodes **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector2` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -162,7 +162,7 @@ The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the clo .. _class_AStar2D_method_get_id_path: -- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PackedInt32Array` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. @@ -195,7 +195,7 @@ Returns the capacity of the structure backing the points, useful in conjunction .. _class_AStar2D_method_get_point_connections: -- :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** +- :ref:`PackedInt32Array` **get_point_connections** **(** :ref:`int` id **)** Returns an array with the IDs of the points that form the connection with the given point. @@ -224,7 +224,7 @@ Returns the number of points currently in the points pool. .. _class_AStar2D_method_get_point_path: -- :ref:`PoolVector2Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PackedVector2Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 0a5cf070a..1420ac512 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -9,36 +9,34 @@ AtlasTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. Description ----------- -:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, and a region that defines the actual area of the AtlasTexture. +:ref:`Texture2D` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture2D`, a margin that defines the border width, and a region that defines the actual area of the AtlasTexture. Properties ---------- -+-------------------------------+-------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`atlas` | | -+-------------------------------+-------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`filter_clip` | ``false`` | -+-------------------------------+-------------------------------------------------------------+-------------------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-------------------------------+-------------------------------------------------------------+-------------------------+ -| :ref:`Rect2` | :ref:`margin` | ``Rect2( 0, 0, 0, 0 )`` | -+-------------------------------+-------------------------------------------------------------+-------------------------+ -| :ref:`Rect2` | :ref:`region` | ``Rect2( 0, 0, 0, 0 )`` | -+-------------------------------+-------------------------------------------------------------+-------------------------+ ++-----------------------------------+-------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`atlas` | | ++-----------------------------------+-------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`filter_clip` | ``false`` | ++-----------------------------------+-------------------------------------------------------------+-------------------------+ +| :ref:`Rect2` | :ref:`margin` | ``Rect2( 0, 0, 0, 0 )`` | ++-----------------------------------+-------------------------------------------------------------+-------------------------+ +| :ref:`Rect2` | :ref:`region` | ``Rect2( 0, 0, 0, 0 )`` | ++-----------------------------------+-------------------------------------------------------------+-------------------------+ Property Descriptions --------------------- .. _class_AtlasTexture_property_atlas: -- :ref:`Texture` **atlas** +- :ref:`Texture2D` **atlas** +----------+------------------+ | *Setter* | set_atlas(value) | @@ -46,7 +44,7 @@ Property Descriptions | *Getter* | get_atlas() | +----------+------------------+ -The texture that contains the atlas. Can be any :ref:`Texture` subtype. +The texture that contains the atlas. Can be any :ref:`Texture2D` subtype. ---- diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 7a7763d2a..be2b6c765 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -33,21 +33,21 @@ Compressor has many uses in the mix: Properties ---------- -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`attack_us` | ``20.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`gain` | ``0.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`mix` | ``1.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`ratio` | ``4.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`release_ms` | ``250.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`sidechain` | ``""`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`threshold` | ``0.0`` | -+-----------------------------+--------------------------------------------------------------------+-----------+ ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`attack_us` | ``20.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`gain` | ``0.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`mix` | ``1.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`ratio` | ``4.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`release_ms` | ``250.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`StringName` | :ref:`sidechain` | ``@""`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`threshold` | ``0.0`` | ++-------------------------------------+--------------------------------------------------------------------+-----------+ Property Descriptions --------------------- @@ -134,10 +134,10 @@ Compressor's delay time to stop reducing the signal after the signal level falls .. _class_AudioEffectCompressor_property_sidechain: -- :ref:`String` **sidechain** +- :ref:`StringName` **sidechain** +-----------+----------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+----------------------+ | *Setter* | set_sidechain(value) | +-----------+----------------------+ diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index ac0e0699c..366d6d231 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -11,7 +11,12 @@ AudioEffectRecord **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +Audio effect used for recording sound from a microphone. +Tutorials +--------- + +- :doc:`../tutorials/audio/recording_with_microphone` Properties ---------- @@ -46,6 +51,8 @@ Property Descriptions | *Getter* | get_format() | +-----------+-------------------+ +Specifies the format in which the sample will be recorded. See :ref:`Format` for available formats. + Method Descriptions ------------------- @@ -53,15 +60,21 @@ Method Descriptions - :ref:`AudioStreamSample` **get_recording** **(** **)** const +Returns the recorded sample. + ---- .. _class_AudioEffectRecord_method_is_recording_active: - :ref:`bool` **is_recording_active** **(** **)** const +Returns whether the recording is active or not. + ---- .. _class_AudioEffectRecord_method_set_recording_active: - void **set_recording_active** **(** :ref:`bool` record **)** +If ``true``, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. + diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 09f77509f..7d38be648 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -58,7 +58,7 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioEffectInstance` | :ref:`get_bus_effect_instance` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`StringName` bus_name **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,7 +66,7 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | +| :ref:`StringName` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,7 +108,7 @@ Methods +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`StringName` send **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -285,7 +285,7 @@ Returns the :ref:`AudioEffectInstance` assigned to th .. _class_AudioServer_method_get_bus_index: -- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const +- :ref:`int` **get_bus_index** **(** :ref:`StringName` bus_name **)** const Returns the index of the bus with the name ``bus_name``. @@ -317,7 +317,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe .. _class_AudioServer_method_get_bus_send: -- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const +- :ref:`StringName` **get_bus_send** **(** :ref:`int` bus_idx **)** const Returns the name of the bus that the bus at index ``bus_idx`` sends to. @@ -487,7 +487,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``. .. _class_AudioServer_method_set_bus_send: -- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** +- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`StringName` send **)** Connects the output of the bus at ``bus_idx`` to the bus named ``send``. diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 84ea1d1e9..84d744a33 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -21,19 +21,19 @@ Tutorials Methods ------- -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** const | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_buffer` **(** **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frames_available` **(** **)** const | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_skips` **(** **)** const | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_buffer` **(** :ref:`PoolVector2Array` frames **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`push_frame` **(** :ref:`Vector2` frame **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** const | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_buffer` **(** **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frames_available` **(** **)** const | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_skips` **(** **)** const | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`push_buffer` **(** :ref:`PackedVector2Array` frames **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`push_frame` **(** :ref:`Vector2` frame **)** | ++-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -64,7 +64,7 @@ Method Descriptions .. _class_AudioStreamGeneratorPlayback_method_push_buffer: -- :ref:`bool` **push_buffer** **(** :ref:`PoolVector2Array` frames **)** +- :ref:`bool` **push_buffer** **(** :ref:`PackedVector2Array` frames **)** ---- diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index a4cfbb959..dab71808d 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -21,28 +21,28 @@ OGG Vorbis audio stream driver. Properties ---------- -+-------------------------------------------+---------------------------------------------------------------------+-----------------------+ -| :ref:`PoolByteArray` | :ref:`data` | ``PoolByteArray( )`` | -+-------------------------------------------+---------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`loop` | ``false`` | -+-------------------------------------------+---------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`loop_offset` | ``0.0`` | -+-------------------------------------------+---------------------------------------------------------------------+-----------------------+ ++-----------------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`PackedByteArray` | :ref:`data` | ``PackedByteArray( )`` | ++-----------------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`loop` | ``false`` | ++-----------------------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`loop_offset` | ``0.0`` | ++-----------------------------------------------+---------------------------------------------------------------------+-------------------------+ Property Descriptions --------------------- .. _class_AudioStreamOGGVorbis_property_data: -- :ref:`PoolByteArray` **data** +- :ref:`PackedByteArray` **data** -+-----------+-----------------------+ -| *Default* | ``PoolByteArray( )`` | -+-----------+-----------------------+ -| *Setter* | set_data(value) | -+-----------+-----------------------+ -| *Getter* | get_data() | -+-----------+-----------------------+ ++-----------+-------------------------+ +| *Default* | ``PackedByteArray( )`` | ++-----------+-------------------------+ +| *Setter* | set_data(value) | ++-----------+-------------------------+ +| *Getter* | get_data() | ++-----------+-------------------------+ Contains the audio data in bytes. diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index fcf27e34c..f05a1b7c0 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -26,23 +26,23 @@ Tutorials Properties ---------- -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`autoplay` | ``false`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`bus` | ``"Master"`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`MixTarget` | :ref:`mix_target` | ``0`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`playing` | ``false`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`AudioStream` | :ref:`stream` | | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`stream_paused` | ``false`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`volume_db` | ``0.0`` | -+----------------------------------------------------+----------------------------------------------------------------------+--------------+ ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`autoplay` | ``false`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`bus` | ``@"Master"`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`MixTarget` | :ref:`mix_target` | ``0`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`playing` | ``false`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`AudioStream` | :ref:`stream` | | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`stream_paused` | ``false`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`volume_db` | ``0.0`` | ++----------------------------------------------------+----------------------------------------------------------------------+---------------+ Methods ------- @@ -108,10 +108,10 @@ If ``true``, audio plays when added to scene tree. .. _class_AudioStreamPlayer_property_bus: -- :ref:`String` **bus** +- :ref:`StringName` **bus** +-----------+----------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+----------------+ | *Setter* | set_bus(value) | +-----------+----------------+ diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index bbc167d04..659f61a9d 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -26,27 +26,27 @@ Tutorials Properties ---------- -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`area_mask` | ``1`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`attenuation` | ``1.0`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`autoplay` | ``false`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`bus` | ``"Master"`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`max_distance` | ``2000.0`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`playing` | ``false`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`AudioStream` | :ref:`stream` | | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`stream_paused` | ``false`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`volume_db` | ``0.0`` | -+---------------------------------------+------------------------------------------------------------------------+--------------+ ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`int` | :ref:`area_mask` | ``1`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`attenuation` | ``1.0`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`autoplay` | ``false`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`bus` | ``@"Master"`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`max_distance` | ``2000.0`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`playing` | ``false`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`AudioStream` | :ref:`stream` | | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`stream_paused` | ``false`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`volume_db` | ``0.0`` | ++---------------------------------------+------------------------------------------------------------------------+---------------+ Methods ------- @@ -125,10 +125,10 @@ If ``true``, audio plays when added to scene tree. .. _class_AudioStreamPlayer2D_property_bus: -- :ref:`String` **bus** +- :ref:`StringName` **bus** +-----------+----------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+----------------+ | *Setter* | set_bus(value) | +-----------+----------------+ diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 8f167e472..adac006cb 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -26,45 +26,45 @@ Tutorials Properties ---------- -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`area_mask` | ``1`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | ``5000.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`attenuation_filter_db` | ``-24.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`AttenuationModel` | :ref:`attenuation_model` | ``0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`autoplay` | ``false`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`bus` | ``"Master"`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`emission_angle_degrees` | ``45.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`emission_angle_enabled` | ``false`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | ``-12.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`max_db` | ``3.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`max_distance` | ``0.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | ``0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`playing` | ``false`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`AudioStream` | :ref:`stream` | | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`stream_paused` | ``false`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`unit_db` | ``0.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`unit_size` | ``1.0`` | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+--------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`int` | :ref:`area_mask` | ``1`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`attenuation_filter_cutoff_hz` | ``5000.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`attenuation_filter_db` | ``-24.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`AttenuationModel` | :ref:`attenuation_model` | ``0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`autoplay` | ``false`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`bus` | ``@"Master"`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`emission_angle_degrees` | ``45.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`emission_angle_enabled` | ``false`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`emission_angle_filter_attenuation_db` | ``-12.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`max_db` | ``3.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`max_distance` | ``0.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`OutOfRangeMode` | :ref:`out_of_range_mode` | ``0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`pitch_scale` | ``1.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`playing` | ``false`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`AudioStream` | :ref:`stream` | | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`stream_paused` | ``false`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`unit_db` | ``0.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`unit_size` | ``1.0`` | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------+ Methods ------- @@ -230,10 +230,10 @@ If ``true``, audio plays when added to scene tree. .. _class_AudioStreamPlayer3D_property_bus: -- :ref:`String` **bus** +- :ref:`StringName` **bus** +-----------+----------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+----------------+ | *Setter* | set_bus(value) | +-----------+----------------+ diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 31d36b83c..d6e00bf42 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -23,21 +23,21 @@ This class can also be used to store dynamically-generated PCM audio data. Properties ---------- -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`PoolByteArray` | :ref:`data` | ``PoolByteArray( )`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`Format` | :ref:`format` | ``0`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`int` | :ref:`loop_begin` | ``0`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`int` | :ref:`loop_end` | ``0`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`int` | :ref:`mix_rate` | ``44100`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`stereo` | ``false`` | -+--------------------------------------------------+----------------------------------------------------------------+-----------------------+ ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`PackedByteArray` | :ref:`data` | ``PackedByteArray( )`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`Format` | :ref:`format` | ``0`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`loop_begin` | ``0`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`loop_end` | ``0`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`mix_rate` | ``44100`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`stereo` | ``false`` | ++--------------------------------------------------+----------------------------------------------------------------+-------------------------+ Methods ------- @@ -92,15 +92,15 @@ Property Descriptions .. _class_AudioStreamSample_property_data: -- :ref:`PoolByteArray` **data** +- :ref:`PackedByteArray` **data** -+-----------+-----------------------+ -| *Default* | ``PoolByteArray( )`` | -+-----------+-----------------------+ -| *Setter* | set_data(value) | -+-----------+-----------------------+ -| *Getter* | get_data() | -+-----------+-----------------------+ ++-----------+-------------------------+ +| *Default* | ``PackedByteArray( )`` | ++-----------+-------------------------+ +| *Setter* | set_data(value) | ++-----------+-------------------------+ +| *Getter* | get_data() | ++-----------+-------------------------+ Contains the audio data in bytes. diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst deleted file mode 100644 index 6bf246399..000000000 --- a/classes/class_bakedlightmap.rst +++ /dev/null @@ -1,312 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the BakedLightmap.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_BakedLightmap: - -BakedLightmap -============= - -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -Prerendered indirect light map for a scene. - -Description ------------ - -Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. - -Tutorials ---------- - -- :doc:`../tutorials/3d/baked_lightmaps` - -Properties ----------- - -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`bake_cell_size` | ``0.25`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`bake_default_texels_per_unit` | ``20.0`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`bake_energy` | ``1.0`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Vector3` | :ref:`bake_extents` | ``Vector3( 10, 10, 10 )`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`bake_hdr` | ``false`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`BakeMode` | :ref:`bake_mode` | ``0`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`bake_propagation` | ``1.0`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`BakeQuality` | :ref:`bake_quality` | ``1`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`capture_cell_size` | ``0.5`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`String` | :ref:`image_path` | ``"."`` | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`BakedLightmapData` | :ref:`light_data` | | -+----------------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------+ - -Methods -------- - -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BakeError` | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_bake` **(** **)** | -+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_BakedLightmap_BakeQuality: - -.. _class_BakedLightmap_constant_BAKE_QUALITY_LOW: - -.. _class_BakedLightmap_constant_BAKE_QUALITY_MEDIUM: - -.. _class_BakedLightmap_constant_BAKE_QUALITY_HIGH: - -enum **BakeQuality**: - -- **BAKE_QUALITY_LOW** = **0** --- The lowest bake quality mode. Fastest to calculate. - -- **BAKE_QUALITY_MEDIUM** = **1** --- The default bake quality mode. - -- **BAKE_QUALITY_HIGH** = **2** --- The highest bake quality mode. Takes longer to calculate. - ----- - -.. _enum_BakedLightmap_BakeMode: - -.. _class_BakedLightmap_constant_BAKE_MODE_CONE_TRACE: - -.. _class_BakedLightmap_constant_BAKE_MODE_RAY_TRACE: - -enum **BakeMode**: - -- **BAKE_MODE_CONE_TRACE** = **0** --- Less precise but faster bake mode. - -- **BAKE_MODE_RAY_TRACE** = **1** --- More precise bake mode but can take considerably longer to bake. - ----- - -.. _enum_BakedLightmap_BakeError: - -.. _class_BakedLightmap_constant_BAKE_ERROR_OK: - -.. _class_BakedLightmap_constant_BAKE_ERROR_NO_SAVE_PATH: - -.. _class_BakedLightmap_constant_BAKE_ERROR_NO_MESHES: - -.. _class_BakedLightmap_constant_BAKE_ERROR_CANT_CREATE_IMAGE: - -.. _class_BakedLightmap_constant_BAKE_ERROR_USER_ABORTED: - -enum **BakeError**: - -- **BAKE_ERROR_OK** = **0** - -- **BAKE_ERROR_NO_SAVE_PATH** = **1** - -- **BAKE_ERROR_NO_MESHES** = **2** - -- **BAKE_ERROR_CANT_CREATE_IMAGE** = **3** - -- **BAKE_ERROR_USER_ABORTED** = **4** - -Property Descriptions ---------------------- - -.. _class_BakedLightmap_property_bake_cell_size: - -- :ref:`float` **bake_cell_size** - -+-----------+---------------------------+ -| *Default* | ``0.25`` | -+-----------+---------------------------+ -| *Setter* | set_bake_cell_size(value) | -+-----------+---------------------------+ -| *Getter* | get_bake_cell_size() | -+-----------+---------------------------+ - -Grid subdivision size for lightmapper calculation. The default value will work for most cases. Increase for better lighting on small details or if your scene is very large. - ----- - -.. _class_BakedLightmap_property_bake_default_texels_per_unit: - -- :ref:`float` **bake_default_texels_per_unit** - -+-----------+-----------------------------------------+ -| *Default* | ``20.0`` | -+-----------+-----------------------------------------+ -| *Setter* | set_bake_default_texels_per_unit(value) | -+-----------+-----------------------------------------+ -| *Getter* | get_bake_default_texels_per_unit() | -+-----------+-----------------------------------------+ - -If a :ref:`Mesh.lightmap_size_hint` isn't specified, the lightmap baker will dynamically set the lightmap size using this value. This value is measured in texels per world unit. The maximum lightmap texture size is 4096x4096. - ----- - -.. _class_BakedLightmap_property_bake_energy: - -- :ref:`float` **bake_energy** - -+-----------+-------------------+ -| *Default* | ``1.0`` | -+-----------+-------------------+ -| *Setter* | set_energy(value) | -+-----------+-------------------+ -| *Getter* | get_energy() | -+-----------+-------------------+ - -Multiplies the light sources' intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright. - ----- - -.. _class_BakedLightmap_property_bake_extents: - -- :ref:`Vector3` **bake_extents** - -+-----------+---------------------------+ -| *Default* | ``Vector3( 10, 10, 10 )`` | -+-----------+---------------------------+ -| *Setter* | set_extents(value) | -+-----------+---------------------------+ -| *Getter* | get_extents() | -+-----------+---------------------------+ - -The size of the affected area. - ----- - -.. _class_BakedLightmap_property_bake_hdr: - -- :ref:`bool` **bake_hdr** - -+-----------+----------------+ -| *Default* | ``false`` | -+-----------+----------------+ -| *Setter* | set_hdr(value) | -+-----------+----------------+ -| *Getter* | is_hdr() | -+-----------+----------------+ - -If ``true``, the lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller file size. - ----- - -.. _class_BakedLightmap_property_bake_mode: - -- :ref:`BakeMode` **bake_mode** - -+-----------+----------------------+ -| *Default* | ``0`` | -+-----------+----------------------+ -| *Setter* | set_bake_mode(value) | -+-----------+----------------------+ -| *Getter* | get_bake_mode() | -+-----------+----------------------+ - -Lightmapping mode. See :ref:`BakeMode`. - ----- - -.. _class_BakedLightmap_property_bake_propagation: - -- :ref:`float` **bake_propagation** - -+-----------+------------------------+ -| *Default* | ``1.0`` | -+-----------+------------------------+ -| *Setter* | set_propagation(value) | -+-----------+------------------------+ -| *Getter* | get_propagation() | -+-----------+------------------------+ - -Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far. - ----- - -.. _class_BakedLightmap_property_bake_quality: - -- :ref:`BakeQuality` **bake_quality** - -+-----------+-------------------------+ -| *Default* | ``1`` | -+-----------+-------------------------+ -| *Setter* | set_bake_quality(value) | -+-----------+-------------------------+ -| *Getter* | get_bake_quality() | -+-----------+-------------------------+ - -Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. - ----- - -.. _class_BakedLightmap_property_capture_cell_size: - -- :ref:`float` **capture_cell_size** - -+-----------+------------------------------+ -| *Default* | ``0.5`` | -+-----------+------------------------------+ -| *Setter* | set_capture_cell_size(value) | -+-----------+------------------------------+ -| *Getter* | get_capture_cell_size() | -+-----------+------------------------------+ - -Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. - ----- - -.. _class_BakedLightmap_property_image_path: - -- :ref:`String` **image_path** - -+-----------+-----------------------+ -| *Default* | ``"."`` | -+-----------+-----------------------+ -| *Setter* | set_image_path(value) | -+-----------+-----------------------+ -| *Getter* | get_image_path() | -+-----------+-----------------------+ - -The location where lightmaps will be saved. - ----- - -.. _class_BakedLightmap_property_light_data: - -- :ref:`BakedLightmapData` **light_data** - -+----------+-----------------------+ -| *Setter* | set_light_data(value) | -+----------+-----------------------+ -| *Getter* | get_light_data() | -+----------+-----------------------+ - -The calculated light data. - -Method Descriptions -------------------- - -.. _class_BakedLightmap_method_bake: - -- :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** - -Bakes the lightmaps within the currently edited scene. - ----- - -.. _class_BakedLightmap_method_debug_bake: - -- void **debug_bake** **(** **)** - -Executes a dry run bake of lightmaps within the currently edited scene. - diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst deleted file mode 100644 index 216fe5357..000000000 --- a/classes/class_bakedlightmapdata.rst +++ /dev/null @@ -1,147 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_BakedLightmapData: - -BakedLightmapData -================= - -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - - - -Properties ----------- - -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | ``AABB( 0, 0, 0, 0, 0, 0 )`` | -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform` | :ref:`cell_space_transform` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`cell_subdiv` | ``1`` | -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`energy` | ``1.0`` | -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`octree` | ``PoolByteArray( )`` | -+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+ - -Methods -------- - -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_users` **(** **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_user_count` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Property Descriptions ---------------------- - -.. _class_BakedLightmapData_property_bounds: - -- :ref:`AABB` **bounds** - -+-----------+------------------------------+ -| *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` | -+-----------+------------------------------+ -| *Setter* | set_bounds(value) | -+-----------+------------------------------+ -| *Getter* | get_bounds() | -+-----------+------------------------------+ - ----- - -.. _class_BakedLightmapData_property_cell_space_transform: - -- :ref:`Transform` **cell_space_transform** - -+-----------+-----------------------------------------------------+ -| *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | -+-----------+-----------------------------------------------------+ -| *Setter* | set_cell_space_transform(value) | -+-----------+-----------------------------------------------------+ -| *Getter* | get_cell_space_transform() | -+-----------+-----------------------------------------------------+ - ----- - -.. _class_BakedLightmapData_property_cell_subdiv: - -- :ref:`int` **cell_subdiv** - -+-----------+------------------------+ -| *Default* | ``1`` | -+-----------+------------------------+ -| *Setter* | set_cell_subdiv(value) | -+-----------+------------------------+ -| *Getter* | get_cell_subdiv() | -+-----------+------------------------+ - ----- - -.. _class_BakedLightmapData_property_energy: - -- :ref:`float` **energy** - -+-----------+-------------------+ -| *Default* | ``1.0`` | -+-----------+-------------------+ -| *Setter* | set_energy(value) | -+-----------+-------------------+ -| *Getter* | get_energy() | -+-----------+-------------------+ - ----- - -.. _class_BakedLightmapData_property_octree: - -- :ref:`PoolByteArray` **octree** - -+-----------+-----------------------+ -| *Default* | ``PoolByteArray( )`` | -+-----------+-----------------------+ -| *Setter* | set_octree(value) | -+-----------+-----------------------+ -| *Getter* | get_octree() | -+-----------+-----------------------+ - -Method Descriptions -------------------- - -.. _class_BakedLightmapData_method_add_user: - -- void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** - ----- - -.. _class_BakedLightmapData_method_clear_users: - -- void **clear_users** **(** **)** - ----- - -.. _class_BakedLightmapData_method_get_user_count: - -- :ref:`int` **get_user_count** **(** **)** const - ----- - -.. _class_BakedLightmapData_method_get_user_lightmap: - -- :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const - ----- - -.. _class_BakedLightmapData_method_get_user_path: - -- :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const - diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst new file mode 100644 index 000000000..aca155bed --- /dev/null +++ b/classes/class_basematerial3d.rst @@ -0,0 +1,2326 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the BaseMaterial3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_BaseMaterial3D: + +BaseMaterial3D +============== + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ORMMaterial3D`, :ref:`StandardMaterial3D` + +Default 3D rendering material. + +Description +----------- + +This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details. + +Tutorials +--------- + +- :doc:`../tutorials/3d/spatial_material` + +Properties +---------- + ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`albedo_color` | ``Color( 1, 1, 1, 1 )`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`albedo_tex_force_srgb` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`albedo_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`alpha_scissor_threshold` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`anisotropy` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`anisotropy_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`anisotropy_flowmap` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`ao_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`ao_light_affect` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`ao_on_uv2` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`ao_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureChannel` | :ref:`ao_texture_channel` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`billboard_keep_scale` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`BillboardMode` | :ref:`billboard_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`BlendMode` | :ref:`blend_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`clearcoat` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`clearcoat_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`clearcoat_gloss` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`clearcoat_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`CullMode` | :ref:`cull_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`DepthDrawMode` | :ref:`depth_draw_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`detail_albedo` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`BlendMode` | :ref:`detail_blend_mode` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`detail_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`detail_mask` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`detail_normal` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`DetailUV` | :ref:`detail_uv_layer` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`DiffuseMode` | :ref:`diffuse_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`disable_ambient_light` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`disable_receive_shadows` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :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:`Texture2D` | :ref:`emission_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`fixed_size` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`grow` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`grow_amount` | ``0.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`heightmap_deep_parallax` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`heightmap_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`heightmap_flip_binormal` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`heightmap_flip_tangent` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`heightmap_flip_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`heightmap_max_layers` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`heightmap_min_layers` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`heightmap_scale` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`heightmap_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`metallic` | ``0.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`metallic_specular` | ``0.5`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`metallic_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureChannel` | :ref:`metallic_texture_channel` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`no_depth_test` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`normal_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`normal_scale` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`normal_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`orm_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`particles_anim_h_frames` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`particles_anim_loop` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`particles_anim_v_frames` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`point_size` | ``1.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :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:`Texture2D` | :ref:`refraction_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureChannel` | :ref:`refraction_texture_channel` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`rim` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`rim_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`rim_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`rim_tint` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`roughness` | ``1.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`roughness_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureChannel` | :ref:`roughness_texture_channel` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`ShadingMode` | :ref:`shading_mode` | ``1`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`shadow_to_opacity` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`SpecularMode` | :ref:`specular_mode` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`subsurf_scatter_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`subsurf_scatter_strength` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`subsurf_scatter_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureFilter` | :ref:`texture_filter` | ``3`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`texture_repeat` | ``true`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`transmission` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`transmission_enabled` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`transmission_texture` | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Transparency` | :ref:`transparency` | ``0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`use_point_size` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :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` | ``1.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`uv1_world_triplanar` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :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` | ``1.0`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`uv2_world_triplanar` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`vertex_color_is_srgb` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ``false`` | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+-------------------------+ + +Methods +------- + ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_feature` **(** :ref:`Feature` feature **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`TextureParam` param **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_feature` **(** :ref:`Feature` feature, :ref:`bool` enable **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_BaseMaterial3D_TextureParam: + +.. _class_BaseMaterial3D_constant_TEXTURE_ALBEDO: + +.. _class_BaseMaterial3D_constant_TEXTURE_METALLIC: + +.. _class_BaseMaterial3D_constant_TEXTURE_ROUGHNESS: + +.. _class_BaseMaterial3D_constant_TEXTURE_EMISSION: + +.. _class_BaseMaterial3D_constant_TEXTURE_NORMAL: + +.. _class_BaseMaterial3D_constant_TEXTURE_RIM: + +.. _class_BaseMaterial3D_constant_TEXTURE_CLEARCOAT: + +.. _class_BaseMaterial3D_constant_TEXTURE_FLOWMAP: + +.. _class_BaseMaterial3D_constant_TEXTURE_AMBIENT_OCCLUSION: + +.. _class_BaseMaterial3D_constant_TEXTURE_HEIGHTMAP: + +.. _class_BaseMaterial3D_constant_TEXTURE_SUBSURFACE_SCATTERING: + +.. _class_BaseMaterial3D_constant_TEXTURE_TRANSMISSION: + +.. _class_BaseMaterial3D_constant_TEXTURE_REFRACTION: + +.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_MASK: + +.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_ALBEDO: + +.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_NORMAL: + +.. _class_BaseMaterial3D_constant_TEXTURE_ORM: + +.. _class_BaseMaterial3D_constant_TEXTURE_MAX: + +enum **TextureParam**: + +- **TEXTURE_ALBEDO** = **0** --- Texture specifying per-pixel color. + +- **TEXTURE_METALLIC** = **1** --- Texture specifying per-pixel metallic value. + +- **TEXTURE_ROUGHNESS** = **2** --- Texture specifying per-pixel roughness value. + +- **TEXTURE_EMISSION** = **3** --- Texture specifying per-pixel emission color. + +- **TEXTURE_NORMAL** = **4** --- Texture specifying per-pixel normal vector. + +- **TEXTURE_RIM** = **5** --- Texture specifying per-pixel rim value. + +- **TEXTURE_CLEARCOAT** = **6** --- Texture specifying per-pixel clearcoat value. + +- **TEXTURE_FLOWMAP** = **7** --- Texture specifying per-pixel flowmap direction for use with :ref:`anisotropy`. + +- **TEXTURE_AMBIENT_OCCLUSION** = **8** --- Texture specifying per-pixel ambient occlusion value. + +- **TEXTURE_HEIGHTMAP** = **9** --- Texture specifying per-pixel height. + +- **TEXTURE_SUBSURFACE_SCATTERING** = **10** --- Texture specifying per-pixel subsurface scattering. + +- **TEXTURE_TRANSMISSION** = **11** --- Texture specifying per-pixel transmission color. + +- **TEXTURE_REFRACTION** = **12** --- Texture specifying per-pixel refraction strength. + +- **TEXTURE_DETAIL_MASK** = **13** --- Texture specifying per-pixel detail mask blending value. + +- **TEXTURE_DETAIL_ALBEDO** = **14** --- Texture specifying per-pixel detail color. + +- **TEXTURE_DETAIL_NORMAL** = **15** --- Texture specifying per-pixel detail normal. + +- **TEXTURE_ORM** = **16** + +- **TEXTURE_MAX** = **17** --- Represents the size of the :ref:`TextureParam` enum. + +---- + +.. _enum_BaseMaterial3D_TextureFilter: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: + +.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_MAX: + +enum **TextureFilter**: + +- **TEXTURE_FILTER_NEAREST** = **0** --- The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. + +- **TEXTURE_FILTER_LINEAR** = **1** --- The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style. + +- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **2** + +- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **3** + +- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = **4** + +- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = **5** + +- **TEXTURE_FILTER_MAX** = **6** --- Represents the size of the :ref:`TextureFilter` enum. + +---- + +.. _enum_BaseMaterial3D_DetailUV: + +.. _class_BaseMaterial3D_constant_DETAIL_UV_1: + +.. _class_BaseMaterial3D_constant_DETAIL_UV_2: + +enum **DetailUV**: + +- **DETAIL_UV_1** = **0** --- Use ``UV`` with the detail texture. + +- **DETAIL_UV_2** = **1** --- Use ``UV2`` with the detail texture. + +---- + +.. _enum_BaseMaterial3D_Transparency: + +.. _class_BaseMaterial3D_constant_TRANSPARENCY_DISABLED: + +.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA: + +.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA_SCISSOR: + +.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA_DEPTH_PRE_PASS: + +.. _class_BaseMaterial3D_constant_TRANSPARENCY_MAX: + +enum **Transparency**: + +- **TRANSPARENCY_DISABLED** = **0** --- The material will not use transparency. + +- **TRANSPARENCY_ALPHA** = **1** --- The material will use the texture's alpha values for transparency. + +- **TRANSPARENCY_ALPHA_SCISSOR** = **2** + +- **TRANSPARENCY_ALPHA_DEPTH_PRE_PASS** = **3** + +- **TRANSPARENCY_MAX** = **4** --- Represents the size of the :ref:`Transparency` enum. + +---- + +.. _enum_BaseMaterial3D_ShadingMode: + +.. _class_BaseMaterial3D_constant_SHADING_MODE_UNSHADED: + +.. _class_BaseMaterial3D_constant_SHADING_MODE_PER_PIXEL: + +.. _class_BaseMaterial3D_constant_SHADING_MODE_PER_VERTEX: + +.. _class_BaseMaterial3D_constant_SHADING_MODE_MAX: + +enum **ShadingMode**: + +- **SHADING_MODE_UNSHADED** = **0** --- The object will not receive shadows. + +- **SHADING_MODE_PER_PIXEL** = **1** --- The object will be shaded per pixel. Useful for realistic shading effect. + +- **SHADING_MODE_PER_VERTEX** = **2** --- The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality. + +- **SHADING_MODE_MAX** = **3** --- Represents the size of the :ref:`ShadingMode` enum. + +---- + +.. _enum_BaseMaterial3D_Feature: + +.. _class_BaseMaterial3D_constant_FEATURE_EMISSION: + +.. _class_BaseMaterial3D_constant_FEATURE_NORMAL_MAPPING: + +.. _class_BaseMaterial3D_constant_FEATURE_RIM: + +.. _class_BaseMaterial3D_constant_FEATURE_CLEARCOAT: + +.. _class_BaseMaterial3D_constant_FEATURE_ANISOTROPY: + +.. _class_BaseMaterial3D_constant_FEATURE_AMBIENT_OCCLUSION: + +.. _class_BaseMaterial3D_constant_FEATURE_HEIGHT_MAPPING: + +.. _class_BaseMaterial3D_constant_FEATURE_SUBSURACE_SCATTERING: + +.. _class_BaseMaterial3D_constant_FEATURE_TRANSMISSION: + +.. _class_BaseMaterial3D_constant_FEATURE_REFRACTION: + +.. _class_BaseMaterial3D_constant_FEATURE_DETAIL: + +.. _class_BaseMaterial3D_constant_FEATURE_MAX: + +enum **Feature**: + +- **FEATURE_EMISSION** = **0** --- Constant for setting :ref:`emission_enabled`. + +- **FEATURE_NORMAL_MAPPING** = **1** --- Constant for setting :ref:`normal_enabled`. + +- **FEATURE_RIM** = **2** --- Constant for setting :ref:`rim_enabled`. + +- **FEATURE_CLEARCOAT** = **3** --- Constant for setting :ref:`clearcoat_enabled`. + +- **FEATURE_ANISOTROPY** = **4** --- Constant for setting :ref:`anisotropy_enabled`. + +- **FEATURE_AMBIENT_OCCLUSION** = **5** --- Constant for setting :ref:`ao_enabled`. + +- **FEATURE_HEIGHT_MAPPING** = **6** + +- **FEATURE_SUBSURACE_SCATTERING** = **7** --- Constant for setting :ref:`subsurf_scatter_enabled`. + +- **FEATURE_TRANSMISSION** = **8** --- Constant for setting :ref:`transmission_enabled`. + +- **FEATURE_REFRACTION** = **9** --- Constant for setting :ref:`refraction_enabled`. + +- **FEATURE_DETAIL** = **10** --- Constant for setting :ref:`detail_enabled`. + +- **FEATURE_MAX** = **11** --- Represents the size of the :ref:`Feature` enum. + +---- + +.. _enum_BaseMaterial3D_BlendMode: + +.. _class_BaseMaterial3D_constant_BLEND_MODE_MIX: + +.. _class_BaseMaterial3D_constant_BLEND_MODE_ADD: + +.. _class_BaseMaterial3D_constant_BLEND_MODE_SUB: + +.. _class_BaseMaterial3D_constant_BLEND_MODE_MUL: + +enum **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. + +- **BLEND_MODE_ADD** = **1** --- The color of the object is added to the background. + +- **BLEND_MODE_SUB** = **2** --- The color of the object is subtracted from the background. + +- **BLEND_MODE_MUL** = **3** --- The color of the object is multiplied by the background. + +---- + +.. _enum_BaseMaterial3D_DepthDrawMode: + +.. _class_BaseMaterial3D_constant_DEPTH_DRAW_OPAQUE_ONLY: + +.. _class_BaseMaterial3D_constant_DEPTH_DRAW_ALWAYS: + +.. _class_BaseMaterial3D_constant_DEPTH_DRAW_DISABLED: + +enum **DepthDrawMode**: + +- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects. + +- **DEPTH_DRAW_ALWAYS** = **1** --- Depth draw is calculated for both opaque and transparent objects. + +- **DEPTH_DRAW_DISABLED** = **2** --- No depth draw. + +---- + +.. _enum_BaseMaterial3D_CullMode: + +.. _class_BaseMaterial3D_constant_CULL_BACK: + +.. _class_BaseMaterial3D_constant_CULL_FRONT: + +.. _class_BaseMaterial3D_constant_CULL_DISABLED: + +enum **CullMode**: + +- **CULL_BACK** = **0** --- Default cull mode. The back of the object is culled when not visible. + +- **CULL_FRONT** = **1** --- The front of the object is culled when not visible. + +- **CULL_DISABLED** = **2** --- No culling is performed. + +---- + +.. _enum_BaseMaterial3D_Flags: + +.. _class_BaseMaterial3D_constant_FLAG_DISABLE_DEPTH_TEST: + +.. _class_BaseMaterial3D_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR: + +.. _class_BaseMaterial3D_constant_FLAG_SRGB_VERTEX_COLOR: + +.. _class_BaseMaterial3D_constant_FLAG_USE_POINT_SIZE: + +.. _class_BaseMaterial3D_constant_FLAG_FIXED_SIZE: + +.. _class_BaseMaterial3D_constant_FLAG_BILLBOARD_KEEP_SCALE: + +.. _class_BaseMaterial3D_constant_FLAG_UV1_USE_TRIPLANAR: + +.. _class_BaseMaterial3D_constant_FLAG_UV2_USE_TRIPLANAR: + +.. _class_BaseMaterial3D_constant_FLAG_UV1_USE_WORLD_TRIPLANAR: + +.. _class_BaseMaterial3D_constant_FLAG_UV2_USE_WORLD_TRIPLANAR: + +.. _class_BaseMaterial3D_constant_FLAG_AO_ON_UV2: + +.. _class_BaseMaterial3D_constant_FLAG_EMISSION_ON_UV2: + +.. _class_BaseMaterial3D_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB: + +.. _class_BaseMaterial3D_constant_FLAG_DONT_RECEIVE_SHADOWS: + +.. _class_BaseMaterial3D_constant_FLAG_DISABLE_AMBIENT_LIGHT: + +.. _class_BaseMaterial3D_constant_FLAG_USE_SHADOW_TO_OPACITY: + +.. _class_BaseMaterial3D_constant_FLAG_USE_TEXTURE_REPEAT: + +.. _class_BaseMaterial3D_constant_FLAG_INVERT_HEIGHTMAP: + +.. _class_BaseMaterial3D_constant_FLAG_MAX: + +enum **Flags**: + +- **FLAG_DISABLE_DEPTH_TEST** = **0** --- 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. + +- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **1** --- Set ``ALBEDO`` to the per-vertex color specified in the mesh. + +- **FLAG_SRGB_VERTEX_COLOR** = **2** --- Vertex color is in sRGB space and needs to be converted to linear. Only applies in the Vulkan renderer. + +- **FLAG_USE_POINT_SIZE** = **3** --- Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use ``POINT_COORD`` instead of ``UV``. + +- **FLAG_FIXED_SIZE** = **4** --- Object is scaled by depth so that it always appears the same size on screen. + +- **FLAG_BILLBOARD_KEEP_SCALE** = **5** --- Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`billboard_mode` is :ref:`BILLBOARD_ENABLED`. + +- **FLAG_UV1_USE_TRIPLANAR** = **6** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV``. + +- **FLAG_UV2_USE_TRIPLANAR** = **7** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV2``. + +- **FLAG_UV1_USE_WORLD_TRIPLANAR** = **8** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV``. + +- **FLAG_UV2_USE_WORLD_TRIPLANAR** = **9** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV2``. + +- **FLAG_AO_ON_UV2** = **10** --- Use ``UV2`` coordinates to look up from the :ref:`ao_texture`. + +- **FLAG_EMISSION_ON_UV2** = **11** --- Use ``UV2`` coordinates to look up from the :ref:`emission_texture`. + +- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **12** --- Forces the shader to convert albedo from sRGB space to linear space. + +- **FLAG_DONT_RECEIVE_SHADOWS** = **13** --- Disables receiving shadows from other objects. + +- **FLAG_DISABLE_AMBIENT_LIGHT** = **14** --- Disables receiving ambient light. + +- **FLAG_USE_SHADOW_TO_OPACITY** = **15** --- Enables the shadow to opacity feature. + +- **FLAG_USE_TEXTURE_REPEAT** = **16** + +- **FLAG_INVERT_HEIGHTMAP** = **17** --- Invert values read from a depth texture to convert them to height values (heightmap). + +- **FLAG_MAX** = **18** --- Represents the size of the :ref:`Flags` enum. + +---- + +.. _enum_BaseMaterial3D_DiffuseMode: + +.. _class_BaseMaterial3D_constant_DIFFUSE_BURLEY: + +.. _class_BaseMaterial3D_constant_DIFFUSE_LAMBERT: + +.. _class_BaseMaterial3D_constant_DIFFUSE_LAMBERT_WRAP: + +.. _class_BaseMaterial3D_constant_DIFFUSE_OREN_NAYAR: + +.. _class_BaseMaterial3D_constant_DIFFUSE_TOON: + +enum **DiffuseMode**: + +- **DIFFUSE_BURLEY** = **0** --- Default diffuse scattering algorithm. + +- **DIFFUSE_LAMBERT** = **1** --- Diffuse scattering ignores roughness. + +- **DIFFUSE_LAMBERT_WRAP** = **2** --- Extends Lambert to cover more than 90 degrees when roughness increases. + +- **DIFFUSE_OREN_NAYAR** = **3** --- Attempts to use roughness to emulate microsurfacing. + +- **DIFFUSE_TOON** = **4** --- Uses a hard cut for lighting, with smoothing affected by roughness. + +---- + +.. _enum_BaseMaterial3D_SpecularMode: + +.. _class_BaseMaterial3D_constant_SPECULAR_SCHLICK_GGX: + +.. _class_BaseMaterial3D_constant_SPECULAR_BLINN: + +.. _class_BaseMaterial3D_constant_SPECULAR_PHONG: + +.. _class_BaseMaterial3D_constant_SPECULAR_TOON: + +.. _class_BaseMaterial3D_constant_SPECULAR_DISABLED: + +enum **SpecularMode**: + +- **SPECULAR_SCHLICK_GGX** = **0** --- Default specular blob. + +- **SPECULAR_BLINN** = **1** --- Older specular algorithm, included for compatibility. + +- **SPECULAR_PHONG** = **2** --- Older specular algorithm, included for compatibility. + +- **SPECULAR_TOON** = **3** --- Toon blob which changes size based on roughness. + +- **SPECULAR_DISABLED** = **4** --- No specular blob. + +---- + +.. _enum_BaseMaterial3D_BillboardMode: + +.. _class_BaseMaterial3D_constant_BILLBOARD_DISABLED: + +.. _class_BaseMaterial3D_constant_BILLBOARD_ENABLED: + +.. _class_BaseMaterial3D_constant_BILLBOARD_FIXED_Y: + +.. _class_BaseMaterial3D_constant_BILLBOARD_PARTICLES: + +enum **BillboardMode**: + +- **BILLBOARD_DISABLED** = **0** --- Billboard mode is disabled. + +- **BILLBOARD_ENABLED** = **1** --- The object's Z axis will always face the camera. + +- **BILLBOARD_FIXED_Y** = **2** --- The object's X axis will always face the camera. + +- **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. + +---- + +.. _enum_BaseMaterial3D_TextureChannel: + +.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_RED: + +.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_GREEN: + +.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_BLUE: + +.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_ALPHA: + +.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_GRAYSCALE: + +enum **TextureChannel**: + +- **TEXTURE_CHANNEL_RED** = **0** --- Used to read from the red channel of a texture. + +- **TEXTURE_CHANNEL_GREEN** = **1** --- Used to read from the green channel of a texture. + +- **TEXTURE_CHANNEL_BLUE** = **2** --- Used to read from the blue channel of a texture. + +- **TEXTURE_CHANNEL_ALPHA** = **3** --- Used to read from the alpha channel of a texture. + +- **TEXTURE_CHANNEL_GRAYSCALE** = **4** --- Currently unused. + +---- + +.. _enum_BaseMaterial3D_EmissionOperator: + +.. _class_BaseMaterial3D_constant_EMISSION_OP_ADD: + +.. _class_BaseMaterial3D_constant_EMISSION_OP_MULTIPLY: + +enum **EmissionOperator**: + +- **EMISSION_OP_ADD** = **0** --- Adds the emission color to the color from the emission texture. + +- **EMISSION_OP_MULTIPLY** = **1** --- Multiplies the emission color by the color from the emission texture. + +---- + +.. _enum_BaseMaterial3D_DistanceFadeMode: + +.. _class_BaseMaterial3D_constant_DISTANCE_FADE_DISABLED: + +.. _class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_ALPHA: + +.. _class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_DITHER: + +.. _class_BaseMaterial3D_constant_DISTANCE_FADE_OBJECT_DITHER: + +enum **DistanceFadeMode**: + +- **DISTANCE_FADE_DISABLED** = **0** --- Do not use distance fade. + +- **DISTANCE_FADE_PIXEL_ALPHA** = **1** --- Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel. + +- **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`. + +- **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`. + +Property Descriptions +--------------------- + +.. _class_BaseMaterial3D_property_albedo_color: + +- :ref:`Color` **albedo_color** + ++-----------+-------------------------+ +| *Default* | ``Color( 1, 1, 1, 1 )`` | ++-----------+-------------------------+ +| *Setter* | set_albedo(value) | ++-----------+-------------------------+ +| *Getter* | get_albedo() | ++-----------+-------------------------+ + +The material's base color. + +---- + +.. _class_BaseMaterial3D_property_albedo_tex_force_srgb: + +- :ref:`bool` **albedo_tex_force_srgb** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +Forces a conversion of the :ref:`albedo_texture` from sRGB space to linear space. + +---- + +.. _class_BaseMaterial3D_property_albedo_texture: + +- :ref:`Texture2D` **albedo_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture to multiply by :ref:`albedo_color`. Used for basic texturing of objects. + +---- + +.. _class_BaseMaterial3D_property_alpha_scissor_threshold: + +- :ref:`float` **alpha_scissor_threshold** + ++----------+------------------------------------+ +| *Setter* | set_alpha_scissor_threshold(value) | ++----------+------------------------------------+ +| *Getter* | get_alpha_scissor_threshold() | ++----------+------------------------------------+ + +Threshold at which the alpha scissor will discard values. + +---- + +.. _class_BaseMaterial3D_property_anisotropy: + +- :ref:`float` **anisotropy** + ++----------+-----------------------+ +| *Setter* | set_anisotropy(value) | ++----------+-----------------------+ +| *Getter* | get_anisotropy() | ++----------+-----------------------+ + +The strength of the anisotropy effect. + +---- + +.. _class_BaseMaterial3D_property_anisotropy_enabled: + +- :ref:`bool` **anisotropy_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Mesh tangents are needed for this to work. If the mesh does not contain tangents the anisotropy effect will appear broken. + +---- + +.. _class_BaseMaterial3D_property_anisotropy_flowmap: + +- :ref:`Texture2D` **anisotropy_flowmap** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that offsets the tangent map for anisotropy calculations. + +---- + +.. _class_BaseMaterial3D_property_ao_enabled: + +- :ref:`bool` **ao_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture`. + +---- + +.. _class_BaseMaterial3D_property_ao_light_affect: + +- :ref:`float` **ao_light_affect** + ++----------+----------------------------+ +| *Setter* | set_ao_light_affect(value) | ++----------+----------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_ao_on_uv2: + +- :ref:`bool` **ao_on_uv2** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture`. + +---- + +.. _class_BaseMaterial3D_property_ao_texture: + +- :ref:`Texture2D` **ao_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that defines the amount of ambient occlusion for a given point on the object. + +---- + +.. _class_BaseMaterial3D_property_ao_texture_channel: + +- :ref:`TextureChannel` **ao_texture_channel** + ++----------+-------------------------------+ +| *Setter* | set_ao_texture_channel(value) | ++----------+-------------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_billboard_keep_scale: + +- :ref:`bool` **billboard_keep_scale** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`billboard_mode` is :ref:`BILLBOARD_ENABLED`. + +---- + +.. _class_BaseMaterial3D_property_billboard_mode: + +- :ref:`BillboardMode` **billboard_mode** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_billboard_mode(value) | ++-----------+---------------------------+ +| *Getter* | get_billboard_mode() | ++-----------+---------------------------+ + +Controls how the object faces the camera. See :ref:`BillboardMode`. + +---- + +.. _class_BaseMaterial3D_property_blend_mode: + +- :ref:`BlendMode` **blend_mode** + ++-----------+-----------------------+ +| *Default* | ``0`` | ++-----------+-----------------------+ +| *Setter* | set_blend_mode(value) | ++-----------+-----------------------+ +| *Getter* | get_blend_mode() | ++-----------+-----------------------+ + +The material's blend mode. + +**Note:** Values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode`. + +---- + +.. _class_BaseMaterial3D_property_clearcoat: + +- :ref:`float` **clearcoat** + ++----------+----------------------+ +| *Setter* | set_clearcoat(value) | ++----------+----------------------+ +| *Getter* | get_clearcoat() | ++----------+----------------------+ + +Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect. + +---- + +.. _class_BaseMaterial3D_property_clearcoat_enabled: + +- :ref:`bool` **clearcoat_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_clearcoat_gloss: + +- :ref:`float` **clearcoat_gloss** + ++----------+----------------------------+ +| *Setter* | set_clearcoat_gloss(value) | ++----------+----------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_clearcoat_texture: + +- :ref:`Texture2D` **clearcoat_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_cull_mode: + +- :ref:`CullMode` **cull_mode** + ++-----------+----------------------+ +| *Default* | ``0`` | ++-----------+----------------------+ +| *Setter* | set_cull_mode(value) | ++-----------+----------------------+ +| *Getter* | get_cull_mode() | ++-----------+----------------------+ + +Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. + +---- + +.. _class_BaseMaterial3D_property_depth_draw_mode: + +- :ref:`DepthDrawMode` **depth_draw_mode** + ++-----------+----------------------------+ +| *Default* | ``0`` | ++-----------+----------------------------+ +| *Setter* | set_depth_draw_mode(value) | ++-----------+----------------------------+ +| *Getter* | get_depth_draw_mode() | ++-----------+----------------------------+ + +Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`transparency`. + +---- + +.. _class_BaseMaterial3D_property_detail_albedo: + +- :ref:`Texture2D` **detail_albedo** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that specifies the color of the detail overlay. + +---- + +.. _class_BaseMaterial3D_property_detail_blend_mode: + +- :ref:`BlendMode` **detail_blend_mode** + ++----------+------------------------------+ +| *Setter* | set_detail_blend_mode(value) | ++----------+------------------------------+ +| *Getter* | get_detail_blend_mode() | ++----------+------------------------------+ + +Specifies how the :ref:`detail_albedo` should blend with the current ``ALBEDO``. See :ref:`BlendMode` for options. + +---- + +.. _class_BaseMaterial3D_property_detail_enabled: + +- :ref:`bool` **detail_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_detail_mask: + +- :ref:`Texture2D` **detail_mask** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to specify how the detail textures get blended with the base textures. + +---- + +.. _class_BaseMaterial3D_property_detail_normal: + +- :ref:`Texture2D` **detail_normal** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that specifies the per-pixel normal of the detail overlay. + +---- + +.. _class_BaseMaterial3D_property_detail_uv_layer: + +- :ref:`DetailUV` **detail_uv_layer** + ++----------+----------------------+ +| *Setter* | set_detail_uv(value) | ++----------+----------------------+ +| *Getter* | get_detail_uv() | ++----------+----------------------+ + +Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV` for options. + +---- + +.. _class_BaseMaterial3D_property_diffuse_mode: + +- :ref:`DiffuseMode` **diffuse_mode** + ++-----------+-------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------+ +| *Setter* | set_diffuse_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_diffuse_mode() | ++-----------+-------------------------+ + +The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. + +---- + +.. _class_BaseMaterial3D_property_disable_ambient_light: + +- :ref:`bool` **disable_ambient_light** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the object receives no ambient light. + +---- + +.. _class_BaseMaterial3D_property_disable_receive_shadows: + +- :ref:`bool` **disable_receive_shadows** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the object receives no shadow that would otherwise be cast onto it. + +---- + +.. _class_BaseMaterial3D_property_distance_fade_max_distance: + +- :ref:`float` **distance_fade_max_distance** + ++----------+---------------------------------------+ +| *Setter* | set_distance_fade_max_distance(value) | ++----------+---------------------------------------+ +| *Getter* | get_distance_fade_max_distance() | ++----------+---------------------------------------+ + +Distance at which the object fades fully and is no longer visible. + +---- + +.. _class_BaseMaterial3D_property_distance_fade_min_distance: + +- :ref:`float` **distance_fade_min_distance** + ++----------+---------------------------------------+ +| *Setter* | set_distance_fade_min_distance(value) | ++----------+---------------------------------------+ +| *Getter* | get_distance_fade_min_distance() | ++----------+---------------------------------------+ + +Distance at which the object starts to fade. If the object is less than this distance away it will appear normal. + +---- + +.. _class_BaseMaterial3D_property_distance_fade_mode: + +- :ref:`DistanceFadeMode` **distance_fade_mode** + ++-----------+--------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------+ +| *Setter* | set_distance_fade(value) | ++-----------+--------------------------+ +| *Getter* | get_distance_fade() | ++-----------+--------------------------+ + +Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode`\ s. + +---- + +.. _class_BaseMaterial3D_property_emission: + +- :ref:`Color` **emission** + ++----------+---------------------+ +| *Setter* | set_emission(value) | ++----------+---------------------+ +| *Getter* | get_emission() | ++----------+---------------------+ + +The emitted light's color. See :ref:`emission_enabled`. + +---- + +.. _class_BaseMaterial3D_property_emission_enabled: + +- :ref:`bool` **emission_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +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` is used and this object is used in baked lighting. + +---- + +.. _class_BaseMaterial3D_property_emission_energy: + +- :ref:`float` **emission_energy** + ++----------+----------------------------+ +| *Setter* | set_emission_energy(value) | ++----------+----------------------------+ +| *Getter* | get_emission_energy() | ++----------+----------------------------+ + +The emitted light's strength. See :ref:`emission_enabled`. + +---- + +.. _class_BaseMaterial3D_property_emission_on_uv2: + +- :ref:`bool` **emission_on_uv2** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +Use ``UV2`` to read from the :ref:`emission_texture`. + +---- + +.. _class_BaseMaterial3D_property_emission_operator: + +- :ref:`EmissionOperator` **emission_operator** + ++----------+------------------------------+ +| *Setter* | set_emission_operator(value) | ++----------+------------------------------+ +| *Getter* | get_emission_operator() | ++----------+------------------------------+ + +Sets how :ref:`emission` interacts with :ref:`emission_texture`. Can either add or multiply. See :ref:`EmissionOperator` for options. + +---- + +.. _class_BaseMaterial3D_property_emission_texture: + +- :ref:`Texture2D` **emission_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that specifies how much surface emits light at a given point. + +---- + +.. _class_BaseMaterial3D_property_fixed_size: + +- :ref:`bool` **fixed_size** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the object is rendered at the same size regardless of distance. + +---- + +.. _class_BaseMaterial3D_property_grow: + +- :ref:`bool` **grow** + ++-----------+-------------------------+ +| *Default* | ``false`` | ++-----------+-------------------------+ +| *Setter* | set_grow_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_grow_enabled() | ++-----------+-------------------------+ + +If ``true``, enables the vertex grow setting. See :ref:`grow_amount`. + +---- + +.. _class_BaseMaterial3D_property_grow_amount: + +- :ref:`float` **grow_amount** + ++-----------+-----------------+ +| *Default* | ``0.0`` | ++-----------+-----------------+ +| *Setter* | set_grow(value) | ++-----------+-----------------+ +| *Getter* | get_grow() | ++-----------+-----------------+ + +Grows object vertices in the direction of their normals. + +---- + +.. _class_BaseMaterial3D_property_heightmap_deep_parallax: + +- :ref:`bool` **heightmap_deep_parallax** + ++----------+--------------------------------------+ +| *Setter* | set_heightmap_deep_parallax(value) | ++----------+--------------------------------------+ +| *Getter* | is_heightmap_deep_parallax_enabled() | ++----------+--------------------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_enabled: + +- :ref:`bool` **heightmap_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_flip_binormal: + +- :ref:`bool` **heightmap_flip_binormal** + ++----------+--------------------------------------------------+ +| *Setter* | set_heightmap_deep_parallax_flip_binormal(value) | ++----------+--------------------------------------------------+ +| *Getter* | get_heightmap_deep_parallax_flip_binormal() | ++----------+--------------------------------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_flip_tangent: + +- :ref:`bool` **heightmap_flip_tangent** + ++----------+-------------------------------------------------+ +| *Setter* | set_heightmap_deep_parallax_flip_tangent(value) | ++----------+-------------------------------------------------+ +| *Getter* | get_heightmap_deep_parallax_flip_tangent() | ++----------+-------------------------------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_flip_texture: + +- :ref:`bool` **heightmap_flip_texture** + ++----------+-----------------+ +| *Setter* | set_flag(value) | ++----------+-----------------+ +| *Getter* | get_flag() | ++----------+-----------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_max_layers: + +- :ref:`int` **heightmap_max_layers** + ++----------+-----------------------------------------------+ +| *Setter* | set_heightmap_deep_parallax_max_layers(value) | ++----------+-----------------------------------------------+ +| *Getter* | get_heightmap_deep_parallax_max_layers() | ++----------+-----------------------------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_min_layers: + +- :ref:`int` **heightmap_min_layers** + ++----------+-----------------------------------------------+ +| *Setter* | set_heightmap_deep_parallax_min_layers(value) | ++----------+-----------------------------------------------+ +| *Getter* | get_heightmap_deep_parallax_min_layers() | ++----------+-----------------------------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_scale: + +- :ref:`float` **heightmap_scale** + ++----------+----------------------------+ +| *Setter* | set_heightmap_scale(value) | ++----------+----------------------------+ +| *Getter* | get_heightmap_scale() | ++----------+----------------------------+ + +---- + +.. _class_BaseMaterial3D_property_heightmap_texture: + +- :ref:`Texture2D` **heightmap_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +---- + +.. _class_BaseMaterial3D_property_metallic: + +- :ref:`float` **metallic** + ++-----------+---------------------+ +| *Default* | ``0.0`` | ++-----------+---------------------+ +| *Setter* | set_metallic(value) | ++-----------+---------------------+ +| *Getter* | 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`. + +---- + +.. _class_BaseMaterial3D_property_metallic_specular: + +- :ref:`float` **metallic_specular** + ++-----------+---------------------+ +| *Default* | ``0.5`` | ++-----------+---------------------+ +| *Setter* | set_specular(value) | ++-----------+---------------------+ +| *Getter* | 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`. + +---- + +.. _class_BaseMaterial3D_property_metallic_texture: + +- :ref:`Texture2D` **metallic_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to specify metallic for an object. This is multiplied by :ref:`metallic`. + +---- + +.. _class_BaseMaterial3D_property_metallic_texture_channel: + +- :ref:`TextureChannel` **metallic_texture_channel** + ++-----------+-------------------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------------------+ +| *Setter* | set_metallic_texture_channel(value) | ++-----------+-------------------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_no_depth_test: + +- :ref:`bool` **no_depth_test** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, depth testing is disabled and the object will be drawn in render order. + +---- + +.. _class_BaseMaterial3D_property_normal_enabled: + +- :ref:`bool` **normal_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, normal mapping is enabled. + +---- + +.. _class_BaseMaterial3D_property_normal_scale: + +- :ref:`float` **normal_scale** + ++----------+-------------------------+ +| *Setter* | set_normal_scale(value) | ++----------+-------------------------+ +| *Getter* | get_normal_scale() | ++----------+-------------------------+ + +The strength of the normal map's effect. + +---- + +.. _class_BaseMaterial3D_property_normal_texture: + +- :ref:`Texture2D` **normal_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to specify the normal at a given pixel. The ``normal_texture`` only uses the red and green channels. The normal read from ``normal_texture`` is oriented around the surface normal provided by the :ref:`Mesh`. + +---- + +.. _class_BaseMaterial3D_property_orm_texture: + +- :ref:`Texture2D` **orm_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +---- + +.. _class_BaseMaterial3D_property_particles_anim_h_frames: + +- :ref:`int` **particles_anim_h_frames** + ++----------+------------------------------------+ +| *Setter* | set_particles_anim_h_frames(value) | ++----------+------------------------------------+ +| *Getter* | get_particles_anim_h_frames() | ++----------+------------------------------------+ + +The number of horizontal frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. + +---- + +.. _class_BaseMaterial3D_property_particles_anim_loop: + +- :ref:`bool` **particles_anim_loop** + ++----------+--------------------------------+ +| *Setter* | set_particles_anim_loop(value) | ++----------+--------------------------------+ +| *Getter* | get_particles_anim_loop() | ++----------+--------------------------------+ + +If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. + +---- + +.. _class_BaseMaterial3D_property_particles_anim_v_frames: + +- :ref:`int` **particles_anim_v_frames** + ++----------+------------------------------------+ +| *Setter* | set_particles_anim_v_frames(value) | ++----------+------------------------------------+ +| *Getter* | get_particles_anim_v_frames() | ++----------+------------------------------------+ + +The number of vertical frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`billboard_mode`. + +---- + +.. _class_BaseMaterial3D_property_point_size: + +- :ref:`float` **point_size** + ++-----------+-----------------------+ +| *Default* | ``1.0`` | ++-----------+-----------------------+ +| *Setter* | set_point_size(value) | ++-----------+-----------------------+ +| *Getter* | get_point_size() | ++-----------+-----------------------+ + +The point size in pixels. See :ref:`use_point_size`. + +---- + +.. _class_BaseMaterial3D_property_proximity_fade_distance: + +- :ref:`float` **proximity_fade_distance** + ++----------+------------------------------------+ +| *Setter* | set_proximity_fade_distance(value) | ++----------+------------------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_proximity_fade_enable: + +- :ref:`bool` **proximity_fade_enable** + ++-----------+-----------------------------+ +| *Default* | ``false`` | ++-----------+-----------------------------+ +| *Setter* | set_proximity_fade(value) | ++-----------+-----------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_refraction_enabled: + +- :ref:`bool` **refraction_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. + +---- + +.. _class_BaseMaterial3D_property_refraction_scale: + +- :ref:`float` **refraction_scale** + ++----------+-----------------------+ +| *Setter* | set_refraction(value) | ++----------+-----------------------+ +| *Getter* | get_refraction() | ++----------+-----------------------+ + +The strength of the refraction effect. + +---- + +.. _class_BaseMaterial3D_property_refraction_texture: + +- :ref:`Texture2D` **refraction_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale`. + +---- + +.. _class_BaseMaterial3D_property_refraction_texture_channel: + +- :ref:`TextureChannel` **refraction_texture_channel** + ++----------+---------------------------------------+ +| *Setter* | set_refraction_texture_channel(value) | ++----------+---------------------------------------+ +| *Getter* | get_refraction_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. + +---- + +.. _class_BaseMaterial3D_property_rim: + +- :ref:`float` **rim** + ++----------+----------------+ +| *Setter* | set_rim(value) | ++----------+----------------+ +| *Getter* | get_rim() | ++----------+----------------+ + +Sets the strength of the rim lighting effect. + +---- + +.. _class_BaseMaterial3D_property_rim_enabled: + +- :ref:`bool` **rim_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. + +---- + +.. _class_BaseMaterial3D_property_rim_texture: + +- :ref:`Texture2D` **rim_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim`. + +---- + +.. _class_BaseMaterial3D_property_rim_tint: + +- :ref:`float` **rim_tint** + ++----------+---------------------+ +| *Setter* | set_rim_tint(value) | ++----------+---------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_roughness: + +- :ref:`float` **roughness** + ++-----------+----------------------+ +| *Default* | ``1.0`` | ++-----------+----------------------+ +| *Setter* | set_roughness(value) | ++-----------+----------------------+ +| *Getter* | 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`. + +---- + +.. _class_BaseMaterial3D_property_roughness_texture: + +- :ref:`Texture2D` **roughness_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness`. + +---- + +.. _class_BaseMaterial3D_property_roughness_texture_channel: + +- :ref:`TextureChannel` **roughness_texture_channel** + ++-----------+--------------------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------------------+ +| *Setter* | set_roughness_texture_channel(value) | ++-----------+--------------------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_shading_mode: + +- :ref:`ShadingMode` **shading_mode** + ++-----------+-------------------------+ +| *Default* | ``1`` | ++-----------+-------------------------+ +| *Setter* | set_shading_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_shading_mode() | ++-----------+-------------------------+ + +---- + +.. _class_BaseMaterial3D_property_shadow_to_opacity: + +- :ref:`bool` **shadow_to_opacity** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_specular_mode: + +- :ref:`SpecularMode` **specular_mode** + ++-----------+--------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------+ +| *Setter* | set_specular_mode(value) | ++-----------+--------------------------+ +| *Getter* | get_specular_mode() | ++-----------+--------------------------+ + +The method for rendering the specular blob. See :ref:`SpecularMode`. + +---- + +.. _class_BaseMaterial3D_property_subsurf_scatter_enabled: + +- :ref:`bool` **subsurf_scatter_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. + +---- + +.. _class_BaseMaterial3D_property_subsurf_scatter_strength: + +- :ref:`float` **subsurf_scatter_strength** + ++----------+-------------------------------------------+ +| *Setter* | set_subsurface_scattering_strength(value) | ++----------+-------------------------------------------+ +| *Getter* | get_subsurface_scattering_strength() | ++----------+-------------------------------------------+ + +The strength of the subsurface scattering effect. + +---- + +.. _class_BaseMaterial3D_property_subsurf_scatter_texture: + +- :ref:`Texture2D` **subsurf_scatter_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength`. + +---- + +.. _class_BaseMaterial3D_property_texture_filter: + +- :ref:`TextureFilter` **texture_filter** + ++-----------+---------------------------+ +| *Default* | ``3`` | ++-----------+---------------------------+ +| *Setter* | set_texture_filter(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_filter() | ++-----------+---------------------------+ + +Filter flags for the texture. See :ref:`TextureFilter` for options. + +---- + +.. _class_BaseMaterial3D_property_texture_repeat: + +- :ref:`bool` **texture_repeat** + ++-----------+-----------------+ +| *Default* | ``true`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +Repeat flags for the texture. See :ref:`TextureFilter` for options. + +---- + +.. _class_BaseMaterial3D_property_transmission: + +- :ref:`Color` **transmission** + ++----------+-------------------------+ +| *Setter* | set_transmission(value) | ++----------+-------------------------+ +| *Getter* | get_transmission() | ++----------+-------------------------+ + +The color used by the transmission effect. Represents the light passing through an object. + +---- + +.. _class_BaseMaterial3D_property_transmission_enabled: + +- :ref:`bool` **transmission_enabled** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_feature(value) | ++-----------+--------------------+ +| *Getter* | get_feature() | ++-----------+--------------------+ + +If ``true``, the transmission effect is enabled. + +---- + +.. _class_BaseMaterial3D_property_transmission_texture: + +- :ref:`Texture2D` **transmission_texture** + ++----------+--------------------+ +| *Setter* | set_texture(value) | ++----------+--------------------+ +| *Getter* | get_texture() | ++----------+--------------------+ + +Texture used to control the transmission effect per-pixel. Added to :ref:`transmission`. + +---- + +.. _class_BaseMaterial3D_property_transparency: + +- :ref:`Transparency` **transparency** + ++-----------+-------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------+ +| *Setter* | set_transparency(value) | ++-----------+-------------------------+ +| *Getter* | get_transparency() | ++-----------+-------------------------+ + +If ``true``, transparency is enabled on the body. See also :ref:`blend_mode`. + +---- + +.. _class_BaseMaterial3D_property_use_point_size: + +- :ref:`bool` **use_point_size** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +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:`point_size`. + +---- + +.. _class_BaseMaterial3D_property_uv1_offset: + +- :ref:`Vector3` **uv1_offset** + ++-----------+------------------------+ +| *Default* | ``Vector3( 0, 0, 0 )`` | ++-----------+------------------------+ +| *Setter* | set_uv1_offset(value) | ++-----------+------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_uv1_scale: + +- :ref:`Vector3` **uv1_scale** + ++-----------+------------------------+ +| *Default* | ``Vector3( 1, 1, 1 )`` | ++-----------+------------------------+ +| *Setter* | set_uv1_scale(value) | ++-----------+------------------------+ +| *Getter* | get_uv1_scale() | ++-----------+------------------------+ + +How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. + +---- + +.. _class_BaseMaterial3D_property_uv1_triplanar: + +- :ref:`bool` **uv1_triplanar** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_uv1_triplanar_sharpness: + +- :ref:`float` **uv1_triplanar_sharpness** + ++-----------+------------------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------------------+ +| *Setter* | set_uv1_triplanar_blend_sharpness(value) | ++-----------+------------------------------------------+ +| *Getter* | get_uv1_triplanar_blend_sharpness() | ++-----------+------------------------------------------+ + +A lower number blends the texture more softly while a higher number blends the texture more sharply. + +---- + +.. _class_BaseMaterial3D_property_uv1_world_triplanar: + +- :ref:`bool` **uv1_world_triplanar** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, triplanar mapping for ``UV`` is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. + +---- + +.. _class_BaseMaterial3D_property_uv2_offset: + +- :ref:`Vector3` **uv2_offset** + ++-----------+------------------------+ +| *Default* | ``Vector3( 0, 0, 0 )`` | ++-----------+------------------------+ +| *Setter* | set_uv2_offset(value) | ++-----------+------------------------+ +| *Getter* | 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. + +---- + +.. _class_BaseMaterial3D_property_uv2_scale: + +- :ref:`Vector3` **uv2_scale** + ++-----------+------------------------+ +| *Default* | ``Vector3( 1, 1, 1 )`` | ++-----------+------------------------+ +| *Setter* | set_uv2_scale(value) | ++-----------+------------------------+ +| *Getter* | get_uv2_scale() | ++-----------+------------------------+ + +How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. + +---- + +.. _class_BaseMaterial3D_property_uv2_triplanar: + +- :ref:`bool` **uv2_triplanar** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +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. + +---- + +.. _class_BaseMaterial3D_property_uv2_triplanar_sharpness: + +- :ref:`float` **uv2_triplanar_sharpness** + ++-----------+------------------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------------------+ +| *Setter* | set_uv2_triplanar_blend_sharpness(value) | ++-----------+------------------------------------------+ +| *Getter* | get_uv2_triplanar_blend_sharpness() | ++-----------+------------------------------------------+ + +A lower number blends the texture more softly while a higher number blends the texture more sharply. + +---- + +.. _class_BaseMaterial3D_property_uv2_world_triplanar: + +- :ref:`bool` **uv2_world_triplanar** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, triplanar mapping for ``UV2`` is calculated in world space rather than object local space. See also :ref:`uv2_triplanar`. + +---- + +.. _class_BaseMaterial3D_property_vertex_color_is_srgb: + +- :ref:`bool` **vertex_color_is_srgb** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the model's vertex colors are processed as sRGB mode. + +---- + +.. _class_BaseMaterial3D_property_vertex_color_use_as_albedo: + +- :ref:`bool` **vertex_color_use_as_albedo** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +If ``true``, the vertex color is used as albedo color. + +Method Descriptions +------------------- + +.. _class_BaseMaterial3D_method_get_feature: + +- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** const + +Returns ``true``, if the specified :ref:`Feature` is enabled. + +---- + +.. _class_BaseMaterial3D_method_get_flag: + +- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const + +Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. + +---- + +.. _class_BaseMaterial3D_method_get_texture: + +- :ref:`Texture2D` **get_texture** **(** :ref:`TextureParam` param **)** const + +Returns the :ref:`Texture` associated with the specified :ref:`TextureParam`. + +---- + +.. _class_BaseMaterial3D_method_set_feature: + +- void **set_feature** **(** :ref:`Feature` feature, :ref:`bool` enable **)** + +If ``true``, enables the specified :ref:`Feature`. Many features that are available in ``BaseMaterial3D``\ s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to ``true``. + +---- + +.. _class_BaseMaterial3D_method_set_flag: + +- 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. + +---- + +.. _class_BaseMaterial3D_method_set_texture: + +- void **set_texture** **(** :ref:`TextureParam` param, :ref:`Texture2D` texture **)** + +Sets the texture for the slot specified by ``param``. See :ref:`TextureParam` for available slots. + diff --git a/classes/class_basis.rst b/classes/class_basis.rst index e10cb5ce5..687988e80 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -58,7 +58,7 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`inverse` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b, :ref:`float` epsilon=0.00001 **)** | +| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b, :ref:`float` epsilon=1e-05 **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`orthonormalized` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -216,7 +216,7 @@ Returns the inverse of the matrix. .. _class_Basis_method_is_equal_approx: -- :ref:`bool` **is_equal_approx** **(** :ref:`Basis` b, :ref:`float` epsilon=0.00001 **)** +- :ref:`bool` **is_equal_approx** **(** :ref:`Basis` b, :ref:`float` epsilon=1e-05 **)** Returns ``true`` if this basis and ``b`` are approximately equal, by calling ``is_equal_approx`` on each component. diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index b3eb15e03..9308a3b0c 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -41,7 +41,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | +| void | :ref:`add_texture` **(** :ref:`Texture2D` texture **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,7 +51,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | +| :ref:`Texture2D` | :ref:`get_texture` **(** :ref:`int` idx **)** const | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_texture_count` **(** **)** const | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -140,7 +140,7 @@ Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are spe .. _class_BitmapFont_method_add_texture: -- void **add_texture** **(** :ref:`Texture` texture **)** +- void **add_texture** **(** :ref:`Texture2D` texture **)** Adds a texture to the ``BitmapFont``. @@ -180,7 +180,7 @@ Returns a kerning pair as a difference. .. _class_BitmapFont_method_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture2D` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 21b8458fa..255f888c2 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -18,16 +18,14 @@ Base class for box containers. Description ----------- -Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes. +Arranges child :ref:`Control` nodes vertically or horizontally, and rearranges them automatically when their minimum size changes. Properties ---------- -+-----------------------------------------------+---------------------------------------------------------+--------------+ -| :ref:`AlignMode` | :ref:`alignment` | ``0`` | -+-----------------------------------------------+---------------------------------------------------------+--------------+ -| :ref:`MouseFilter` | mouse_filter | **O:** ``1`` | -+-----------------------------------------------+---------------------------------------------------------+--------------+ ++-----------------------------------------------+---------------------------------------------------------+-------+ +| :ref:`AlignMode` | :ref:`alignment` | ``0`` | ++-----------------------------------------------+---------------------------------------------------------+-------+ Methods ------- @@ -70,7 +68,7 @@ Property Descriptions | *Getter* | get_alignment() | +-----------+----------------------+ -The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN`, :ref:`ALIGN_CENTER` or :ref:`ALIGN_END`). +The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN`, :ref:`ALIGN_CENTER`, or :ref:`ALIGN_END`). Method Descriptions ------------------- @@ -79,5 +77,5 @@ Method Descriptions - void **add_spacer** **(** :ref:`bool` begin **)** -Adds a control to the box as a spacer. If ``true``, ``begin`` will insert the spacer control in front of other children. +Adds a :ref:`Control` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control` node in front of all other children. diff --git a/classes/class_button.rst b/classes/class_button.rst index dbf1d9e3d..268bd3138 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -32,7 +32,7 @@ Properties +-----------------------------------------+-------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`flat` | ``false`` | +-----------------------------------------+-------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`icon` | | +| :ref:`Texture2D` | :ref:`icon` | | +-----------------------------------------+-------------------------------------------------------+-----------+ | :ref:`String` | :ref:`text` | ``""`` | +-----------------------------------------+-------------------------------------------------------+-----------+ @@ -152,7 +152,7 @@ Flat buttons don't display decoration. .. _class_Button_property_icon: -- :ref:`Texture` **icon** +- :ref:`Texture2D` **icon** +----------+------------------------+ | *Setter* | set_button_icon(value) | diff --git a/classes/class_callable.rst b/classes/class_callable.rst new file mode 100644 index 000000000..19e83e157 --- /dev/null +++ b/classes/class_callable.rst @@ -0,0 +1,128 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Callable.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Callable: + +Callable +======== + +An object representing a method in a certain object that can be called. + +Description +----------- + +``Callable`` is a first class object which can be held in variables and passed to functions. It represents a given method in an :ref:`Object`, and is typically used for signal callbacks. + +**Example:** + +:: + + var callable = Callable(self, "print_args") + func print_args(arg1, arg2, arg3 = ""): + prints(arg1, arg2, arg3) + func test(): + callable.call("hello", "world") # Prints "hello world". + callable.call(Vector2.UP, 42, callable) # Prints "(0, -1) 42 Node(Node.gd)::print_args". + callable.call("invalid") # Invalid call, should have at least 2 arguments. + +Methods +------- + ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`Callable` **(** :ref:`Object` object, :ref:`StringName` method_name **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** ... **)** vararg | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** ... **)** vararg | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_method` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_object` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_id` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_null` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_standard` **(** **)** | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Callable_method_Callable: + +- :ref:`Callable` **Callable** **(** :ref:`Object` object, :ref:`StringName` method_name **)** + +Creates a new ``Callable`` for the method called ``method_name`` in the specified ``object``. + +---- + +.. _class_Callable_method_call: + +- :ref:`Variant` **call** **(** ... **)** vararg + +Calls the method represented by this ``Callable``. Arguments can be passed and should match the method's signature. + +---- + +.. _class_Callable_method_call_deferred: + +- void **call_deferred** **(** ... **)** vararg + +Calls the method represented by this ``Callable`` in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature. + +---- + +.. _class_Callable_method_get_method: + +- :ref:`StringName` **get_method** **(** **)** + +Returns the name of the method represented by this ``Callable``. + +---- + +.. _class_Callable_method_get_object: + +- :ref:`Object` **get_object** **(** **)** + +Returns the object on which this ``Callable`` is called. + +---- + +.. _class_Callable_method_get_object_id: + +- :ref:`int` **get_object_id** **(** **)** + +Returns the ID of this ``Callable``'s object (see :ref:`Object.get_instance_id`). + +---- + +.. _class_Callable_method_hash: + +- :ref:`int` **hash** **(** **)** + +---- + +.. _class_Callable_method_is_custom: + +- :ref:`bool` **is_custom** **(** **)** + +---- + +.. _class_Callable_method_is_null: + +- :ref:`bool` **is_null** **(** **)** + +---- + +.. _class_Callable_method_is_standard: + +- :ref:`bool` **is_standard** **(** **)** + diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 30aff5787..252fcd0c9 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -30,6 +30,8 @@ Properties +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ | :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ +| :ref:`CameraEffects` | :ref:`effects` | | ++-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ | :ref:`Environment` | :ref:`environment` | | +-----------------------------------------------------+-----------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`far` | ``100.0`` | @@ -190,6 +192,18 @@ If not :ref:`DOPPLER_TRACKING_DISABLED` **effects** + ++----------+--------------------+ +| *Setter* | set_effects(value) | ++----------+--------------------+ +| *Getter* | get_effects() | ++----------+--------------------+ + +---- + .. _class_Camera_property_environment: - :ref:`Environment` **environment** diff --git a/classes/class_cameraeffects.rst b/classes/class_cameraeffects.rst new file mode 100644 index 000000000..37b3e96be --- /dev/null +++ b/classes/class_cameraeffects.rst @@ -0,0 +1,165 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CameraEffects.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CameraEffects: + +CameraEffects +============= + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + + + +Properties +---------- + ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_amount` | ``0.1`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_far_distance` | ``10.0`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`dof_blur_far_enabled` | ``false`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_far_transition` | ``5.0`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_near_distance` | ``2.0`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`dof_blur_near_enabled` | ``false`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_near_transition` | ``1.0`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`override_exposure` | ``1.0`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`override_exposure_enable` | ``false`` | ++---------------------------+----------------------------------------------------------------------------------------+-----------+ + +Property Descriptions +--------------------- + +.. _class_CameraEffects_property_dof_blur_amount: + +- :ref:`float` **dof_blur_amount** + ++-----------+----------------------------+ +| *Default* | ``0.1`` | ++-----------+----------------------------+ +| *Setter* | set_dof_blur_amount(value) | ++-----------+----------------------------+ +| *Getter* | get_dof_blur_amount() | ++-----------+----------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_far_distance: + +- :ref:`float` **dof_blur_far_distance** + ++-----------+----------------------------------+ +| *Default* | ``10.0`` | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_far_distance(value) | ++-----------+----------------------------------+ +| *Getter* | get_dof_blur_far_distance() | ++-----------+----------------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_far_enabled: + +- :ref:`bool` **dof_blur_far_enabled** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_dof_blur_far_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_dof_blur_far_enabled() | ++-----------+---------------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_far_transition: + +- :ref:`float` **dof_blur_far_transition** + ++-----------+------------------------------------+ +| *Default* | ``5.0`` | ++-----------+------------------------------------+ +| *Setter* | set_dof_blur_far_transition(value) | ++-----------+------------------------------------+ +| *Getter* | get_dof_blur_far_transition() | ++-----------+------------------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_near_distance: + +- :ref:`float` **dof_blur_near_distance** + ++-----------+-----------------------------------+ +| *Default* | ``2.0`` | ++-----------+-----------------------------------+ +| *Setter* | set_dof_blur_near_distance(value) | ++-----------+-----------------------------------+ +| *Getter* | get_dof_blur_near_distance() | ++-----------+-----------------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_near_enabled: + +- :ref:`bool` **dof_blur_near_enabled** + ++-----------+----------------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_near_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_dof_blur_near_enabled() | ++-----------+----------------------------------+ + +---- + +.. _class_CameraEffects_property_dof_blur_near_transition: + +- :ref:`float` **dof_blur_near_transition** + ++-----------+-------------------------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------------------------+ +| *Setter* | set_dof_blur_near_transition(value) | ++-----------+-------------------------------------+ +| *Getter* | get_dof_blur_near_transition() | ++-----------+-------------------------------------+ + +---- + +.. _class_CameraEffects_property_override_exposure: + +- :ref:`float` **override_exposure** + ++-----------+------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------+ +| *Setter* | set_override_exposure(value) | ++-----------+------------------------------+ +| *Getter* | get_override_exposure() | ++-----------+------------------------------+ + +---- + +.. _class_CameraEffects_property_override_exposure_enable: + +- :ref:`bool` **override_exposure_enable** + ++-----------+--------------------------------------+ +| *Default* | ``false`` | ++-----------+--------------------------------------+ +| *Setter* | set_override_exposure_enabled(value) | ++-----------+--------------------------------------+ +| *Getter* | is_override_exposure_enabled() | ++-----------+--------------------------------------+ + diff --git a/classes/class_camerafeed.rst b/classes/class_camerafeed.rst index 49d8253fd..f58fd081c 100644 --- a/classes/class_camerafeed.rst +++ b/classes/class_camerafeed.rst @@ -20,122 +20,3 @@ A camera feed gives you access to a single physical camera attached to your devi **Note:** Many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background. -Properties ----------- - -+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ -| :ref:`bool` | :ref:`feed_is_active` | ``false`` | -+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ -| :ref:`Transform2D` | :ref:`feed_transform` | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` | -+---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ - -Methods -------- - -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_id` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`FeedPosition` | :ref:`get_position` **(** **)** const | -+---------------------------------------------------+-----------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_CameraFeed_FeedDataType: - -.. _class_CameraFeed_constant_FEED_NOIMAGE: - -.. _class_CameraFeed_constant_FEED_RGB: - -.. _class_CameraFeed_constant_FEED_YCBCR: - -.. _class_CameraFeed_constant_FEED_YCBCR_SEP: - -enum **FeedDataType**: - -- **FEED_NOIMAGE** = **0** --- No image set for the feed. - -- **FEED_RGB** = **1** --- Feed supplies RGB images. - -- **FEED_YCBCR** = **2** --- Feed supplies YCbCr images that need to be converted to RGB. - -- **FEED_YCBCR_SEP** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB. - ----- - -.. _enum_CameraFeed_FeedPosition: - -.. _class_CameraFeed_constant_FEED_UNSPECIFIED: - -.. _class_CameraFeed_constant_FEED_FRONT: - -.. _class_CameraFeed_constant_FEED_BACK: - -enum **FeedPosition**: - -- **FEED_UNSPECIFIED** = **0** --- Unspecified position. - -- **FEED_FRONT** = **1** --- Camera is mounted at the front of the device. - -- **FEED_BACK** = **2** --- Camera is mounted at the back of the device. - -Property Descriptions ---------------------- - -.. _class_CameraFeed_property_feed_is_active: - -- :ref:`bool` **feed_is_active** - -+-----------+-------------------+ -| *Default* | ``false`` | -+-----------+-------------------+ -| *Setter* | set_active(value) | -+-----------+-------------------+ -| *Getter* | is_active() | -+-----------+-------------------+ - -If ``true``, the feed is active. - ----- - -.. _class_CameraFeed_property_feed_transform: - -- :ref:`Transform2D` **feed_transform** - -+-----------+--------------------------------------+ -| *Default* | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` | -+-----------+--------------------------------------+ -| *Setter* | set_transform(value) | -+-----------+--------------------------------------+ -| *Getter* | get_transform() | -+-----------+--------------------------------------+ - -The transform applied to the camera's image. - -Method Descriptions -------------------- - -.. _class_CameraFeed_method_get_id: - -- :ref:`int` **get_id** **(** **)** const - -Returns the unique ID for this feed. - ----- - -.. _class_CameraFeed_method_get_name: - -- :ref:`String` **get_name** **(** **)** const - -Returns the camera's name. - ----- - -.. _class_CameraFeed_method_get_position: - -- :ref:`FeedPosition` **get_position** **(** **)** const - -Returns the position of camera on the device. - diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 3cf87dfa9..830345d13 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -9,7 +9,7 @@ CameraTexture ============= -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Texture provided by a :ref:`CameraFeed`. @@ -23,15 +23,13 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed` | :ref:`camera_feed_id` | ``0`` | -+-----------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`camera_is_active` | ``false`` | -+-----------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-----------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`FeedImage` | :ref:`which_feed` | ``0`` | -+-----------------------------------------------+------------------------------------------------------------------------+--------------+ ++-----------------------------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`camera_feed_id` | ``0`` | ++-----------------------------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`camera_is_active` | ``false`` | ++-----------------------------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`FeedImage` | :ref:`which_feed` | ``0`` | ++-----------------------------------------------+------------------------------------------------------------------------+-----------+ Property Descriptions --------------------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index a00f4a1c0..df2df2f41 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -38,120 +38,124 @@ Tutorials Properties ---------- -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`light_mask` | ``1`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`Material` | :ref:`material` | | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`Color` | :ref:`self_modulate` | ``Color( 1, 1, 1, 1 )`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`show_behind_parent` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`show_on_top` | | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`use_parent_material` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`visible` | ``true`` | -+---------------------------------+---------------------------------------------------------------------------+-------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`light_mask` | ``1`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`Material` | :ref:`material` | | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`self_modulate` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`show_behind_parent` | ``false`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`show_on_top` | | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`use_parent_material` | ``false`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`visible` | ``true`` | ++-----------------------------------------------------+---------------------------------------------------------------------------+-------------------------+ Methods ------- -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_arc` **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_update_transform` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_arc` **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`Texture2D` texture=null, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture2D` texture, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multiline_colors` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture2D` texture, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`Texture2D` texture=null, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`Texture2D` texture=null, :ref:`float` width=1.0, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=1.0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture2D` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`bool` clip_uv=true, :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_update_transform` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -189,33 +193,67 @@ Emitted when the visibility (hidden/visible) changes. Enumerations ------------ -.. _enum_CanvasItem_BlendMode: +.. _enum_CanvasItem_TextureFilter: -.. _class_CanvasItem_constant_BLEND_MODE_MIX: +.. _class_CanvasItem_constant_TEXTURE_FILTER_PARENT_NODE: -.. _class_CanvasItem_constant_BLEND_MODE_ADD: +.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST: -.. _class_CanvasItem_constant_BLEND_MODE_SUB: +.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR: -.. _class_CanvasItem_constant_BLEND_MODE_MUL: +.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: -.. _class_CanvasItem_constant_BLEND_MODE_PREMULT_ALPHA: +.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: -.. _class_CanvasItem_constant_BLEND_MODE_DISABLED: +.. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: -enum **BlendMode**: +.. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: -- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. +.. _class_CanvasItem_constant_TEXTURE_FILTER_MAX: -- **BLEND_MODE_ADD** = **1** --- Additive blending mode. +enum **TextureFilter**: -- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode. +- **TEXTURE_FILTER_PARENT_NODE** = **0** --- The ``CanvasItem`` will inherit the filter from its parent. -- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode. +- **TEXTURE_FILTER_NEAREST** = **1** --- The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering. Useful for pixel art. -- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. +- **TEXTURE_FILTER_LINEAR** = **2** --- The texture filter blends between the nearest four pixels. Use this for most cases where you want to avoid a pixelated style. -- **BLEND_MODE_DISABLED** = **5** --- Disables blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied. +- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **3** + +- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **4** + +- **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = **5** + +- **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = **6** + +- **TEXTURE_FILTER_MAX** = **7** --- Represents the size of the :ref:`TextureFilter` enum. + +---- + +.. _enum_CanvasItem_TextureRepeat: + +.. _class_CanvasItem_constant_TEXTURE_REPEAT_PARENT_NODE: + +.. _class_CanvasItem_constant_TEXTURE_REPEAT_DISABLED: + +.. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED: + +.. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR: + +.. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX: + +enum **TextureRepeat**: + +- **TEXTURE_REPEAT_PARENT_NODE** = **0** --- The ``CanvasItem`` will inherit the filter from its parent. + +- **TEXTURE_REPEAT_DISABLED** = **1** --- Texture will not repeat. + +- **TEXTURE_REPEAT_ENABLED** = **2** --- Texture will repeat normally. + +- **TEXTURE_REPEAT_MIRROR** = **3** --- Texture will repeat in a 2x2 tiled mode, where elements at even positions are mirrored. + +- **TEXTURE_REPEAT_MAX** = **4** --- Represents the size of the :ref:`TextureRepeat` enum. Constants --------- @@ -329,6 +367,34 @@ If ``true``, the object draws on top of its parent. ---- +.. _class_CanvasItem_property_texture_filter: + +- :ref:`TextureFilter` **texture_filter** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_texture_filter(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_filter() | ++-----------+---------------------------+ + +---- + +.. _class_CanvasItem_property_texture_repeat: + +- :ref:`TextureRepeat` **texture_repeat** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_texture_repeat(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_repeat() | ++-----------+---------------------------+ + +---- + .. _class_CanvasItem_property_use_parent_material: - :ref:`bool` **use_parent_material** @@ -372,7 +438,7 @@ Overridable function called by the engine (if defined) to draw the canvas item. .. _class_CanvasItem_method_draw_arc: -- void **draw_arc** **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_arc** **(** :ref:`Vector2` center, :ref:`float` radius, :ref:`float` start_angle, :ref:`float` end_angle, :ref:`int` point_count, :ref:`Color` color, :ref:`float` width=1.0 **)** Draws an arc between the given angles. The larger the value of ``point_count``, the smoother the curve. @@ -396,7 +462,7 @@ Draws a colored circle. .. _class_CanvasItem_method_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_colored_polygon** **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`Texture2D` texture=null, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a colored polygon of any amount of points, convex or concave. @@ -404,15 +470,15 @@ Draws a colored polygon of any amount of points, convex or concave. .. _class_CanvasItem_method_draw_line: -- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0 **)** -Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. +Draws a line from a 2D point to another, with a given color and width. ---- .. _class_CanvasItem_method_draw_mesh: -- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** +- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture2D` texture, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`MeshInstance2D` for related documentation. @@ -420,23 +486,23 @@ Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`Mes .. _class_CanvasItem_method_draw_multiline: -- void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_multiline** **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0 **)** -Draws multiple, parallel lines with a uniform ``color``. ``width`` and ``antialiased`` are currently not implemented and have no effect. +Draws multiple, parallel lines with a uniform ``color``. ---- .. _class_CanvasItem_method_draw_multiline_colors: -- void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_multiline_colors** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0 **)** -Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. +Draws multiple, parallel lines with a uniform ``width`` and segment-by-segment coloring. Colors assigned to line segments match by index between ``points`` and ``colors``. ---- .. _class_CanvasItem_method_draw_multimesh: -- void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +- void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture2D` texture, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a :ref:`MultiMesh` in 2D with the provided texture. See :ref:`MultiMeshInstance2D` for related documentation. @@ -444,7 +510,7 @@ Draws a :ref:`MultiMesh` in 2D with the provided texture. See : .. _class_CanvasItem_method_draw_polygon: -- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_polygon** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`Texture2D` texture=null, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a polygon of any amount of points, convex or concave. @@ -452,35 +518,35 @@ Draws a polygon of any amount of points, convex or concave. .. _class_CanvasItem_method_draw_polyline: -- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline** **(** :ref:`PackedVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0 **)** -Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing. +Draws interconnected line segments with a uniform ``color`` and ``width``. ---- .. _class_CanvasItem_method_draw_polyline_colors: -- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline_colors** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0 **)** -Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. +Draws interconnected line segments with a uniform ``width`` and segment-by-segment coloring. Colors assigned to line segments match by index between ``points`` and ``colors``. ---- .. _class_CanvasItem_method_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** +- void **draw_primitive** **(** :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`Texture2D` texture=null, :ref:`float` width=1.0, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** -Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. +Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. ---- .. _class_CanvasItem_method_draw_rect: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true, :ref:`float` width=1.0 **)** -Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. If ``antialiased`` is ``true``, the lines will be antialiased. +Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. -**Note:** ``width`` and ``antialiased`` are only effective if ``filled`` is ``false``. +**Note:** ``width`` is only effective if ``filled`` is ``false``. ---- @@ -518,7 +584,7 @@ Draws a styled rectangle. .. _class_CanvasItem_method_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** +- void **draw_texture** **(** :ref:`Texture2D` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a texture at a given position. @@ -526,7 +592,7 @@ Draws a texture at a given position. .. _class_CanvasItem_method_draw_texture_rect: -- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** +- void **draw_texture_rect** **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. @@ -534,7 +600,7 @@ Draws a textured rectangle at a given position, optionally modulated by a color. .. _class_CanvasItem_method_draw_texture_rect_region: -- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** +- void **draw_texture_rect_region** **(** :ref:`Texture2D` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_shininess=Color( 1, 1, 1, 1 ), :ref:`bool` clip_uv=true, :ref:`TextureFilter` texture_filter=0, :ref:`TextureRepeat` texture_repeat=0 **)** Draws a textured rectangle region at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 973be6526..293007af0 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -125,7 +125,7 @@ The manner in which material reacts to lighting. | *Getter* | get_particles_anim_h_frames() | +----------+------------------------------------+ -The number of columns in the spritesheet assigned as :ref:`Texture` for a :ref:`Particles2D` or :ref:`CPUParticles2D`. +The number of columns in the spritesheet assigned as :ref:`Texture2D` for a :ref:`Particles2D` or :ref:`CPUParticles2D`. **Note:** This property is only used and visible in the editor if :ref:`particles_animation` is ``true``. @@ -157,7 +157,7 @@ If ``true``, the particles animation will loop. | *Getter* | get_particles_anim_v_frames() | +----------+------------------------------------+ -The number of rows in the spritesheet assigned as :ref:`Texture` for a :ref:`Particles2D` or :ref:`CPUParticles2D`. +The number of rows in the spritesheet assigned as :ref:`Texture2D` for a :ref:`Particles2D` or :ref:`CPUParticles2D`. **Note:** This property is only used and visible in the editor if :ref:`particles_animation` is ``true``. diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index d12e5ac0a..a0d99f471 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -11,12 +11,12 @@ CheckBox **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Binary choice user interface widget. +Binary choice user interface widget. See also :ref:`CheckButton`. Description ----------- -A checkbox allows the user to make a binary choice (choosing only one of two possible options). +A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to :ref:`CheckButton` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has **no** immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed. Properties ---------- @@ -30,41 +30,41 @@ Properties Theme Properties ---------------- -+---------------------------------+--------------------------+------------------------------+ -| :ref:`int` | check_vadjust | 0 | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | checked | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | disabled | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | hover | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | hover_pressed | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | pressed | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | radio_checked | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | radio_unchecked | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | unchecked | | -+---------------------------------+--------------------------+------------------------------+ ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`int` | check_vadjust | 0 | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | checked | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | disabled | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | hover | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | hover_pressed | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | pressed | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | radio_checked | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | radio_unchecked | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | unchecked | | ++-----------------------------------+--------------------------+------------------------------+ diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index f68bb3626..9537ee3c7 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -11,12 +11,12 @@ CheckButton **Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Checkable button. +Checkable button. See also :ref:`CheckBox`. Description ----------- -CheckButton is a toggle button displayed as a check field. +CheckButton is a toggle button displayed as a check field. It's similar to :ref:`CheckBox` in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an **immediate** effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button. Properties ---------- @@ -30,41 +30,41 @@ Properties Theme Properties ---------------- -+---------------------------------+--------------------------+------------------------------+ -| :ref:`int` | check_vadjust | 0 | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | disabled | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | hover | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | hover_pressed | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | off | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | off_disabled | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | on | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`Texture` | on_disabled | | -+---------------------------------+--------------------------+------------------------------+ -| :ref:`StyleBox` | pressed | | -+---------------------------------+--------------------------+------------------------------+ ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`int` | check_vadjust | 0 | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | disabled | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_hover_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | hover | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | hover_pressed | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | off | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | off_disabled | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | on | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`Texture2D` | on_disabled | | ++-----------------------------------+--------------------------+------------------------------+ +| :ref:`StyleBox` | pressed | | ++-----------------------------------+--------------------------+------------------------------+ diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index e8ba1aa71..4e8df88f4 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -21,54 +21,54 @@ Provides access to metadata stored for every available class. Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_exists` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`class_get_category` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`StringName` class, :ref:`StringName` name **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`StringName` property **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`StringName` class, :ref:`StringName` signal **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`StringName` class, :ref:`StringName` name **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`StringName` class, :ref:`StringName` method, :ref:`bool` no_inheritance=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`StringName` class, :ref:`StringName` signal **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_class_list` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_parent_class` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`StringName` class **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`StringName` class, :ref:`StringName` inherits **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ClassDB_method_can_instance: -- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const +- :ref:`bool` **can_instance** **(** :ref:`StringName` class **)** const Returns ``true`` if you can instance objects from the specified ``class``, ``false`` in other case. @@ -76,7 +76,7 @@ Returns ``true`` if you can instance objects from the specified ``class``, ``fal .. _class_ClassDB_method_class_exists: -- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const +- :ref:`bool` **class_exists** **(** :ref:`StringName` class **)** const Returns whether the specified ``class`` is available or not. @@ -84,7 +84,7 @@ Returns whether the specified ``class`` is available or not. .. _class_ClassDB_method_class_get_category: -- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const +- :ref:`StringName` **class_get_category** **(** :ref:`StringName` class **)** const Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. @@ -92,7 +92,7 @@ Returns a category associated with the class for use in documentation and the As .. _class_ClassDB_method_class_get_integer_constant: -- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`int` **class_get_integer_constant** **(** :ref:`StringName` class, :ref:`StringName` name **)** const Returns the value of the integer constant ``name`` of ``class`` or its ancestry. Always returns 0 when the constant could not be found. @@ -100,7 +100,7 @@ Returns the value of the integer constant ``name`` of ``class`` or its ancestry. .. _class_ClassDB_method_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`PackedStringArray` **class_get_integer_constant_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const Returns an array with the names all the integer constants of ``class`` or its ancestry. @@ -108,7 +108,7 @@ Returns an array with the names all the integer constants of ``class`` or its an .. _class_ClassDB_method_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the methods of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -116,7 +116,7 @@ Returns an array with all the methods of ``class`` or its ancestry if ``no_inher .. _class_ClassDB_method_class_get_property: -- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const +- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`StringName` property **)** const Returns the value of ``property`` of ``class`` or its ancestry. @@ -124,7 +124,7 @@ Returns the value of ``property`` of ``class`` or its ancestry. .. _class_ClassDB_method_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the properties of ``class`` or its ancestry if ``no_inheritance`` is ``false``. @@ -132,7 +132,7 @@ Returns an array with all the properties of ``class`` or its ancestry if ``no_in .. _class_ClassDB_method_class_get_signal: -- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`Dictionary` **class_get_signal** **(** :ref:`StringName` class, :ref:`StringName` signal **)** const Returns the ``signal`` data of ``class`` or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: ``args``, ``default_args``, ``flags``, ``id``, ``name``, ``return: (class_name, hint, hint_string, name, type, usage)``. @@ -140,7 +140,7 @@ Returns the ``signal`` data of ``class`` or its ancestry. The returned value is .. _class_ClassDB_method_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`StringName` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the signals of ``class`` or its ancestry if ``no_inheritance`` is ``false``. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. @@ -148,7 +148,7 @@ Returns an array with all the signals of ``class`` or its ancestry if ``no_inher .. _class_ClassDB_method_class_has_integer_constant: -- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`bool` **class_has_integer_constant** **(** :ref:`StringName` class, :ref:`StringName` name **)** const Returns whether ``class`` or its ancestry has an integer constant called ``name`` or not. @@ -156,7 +156,7 @@ Returns whether ``class`` or its ancestry has an integer constant called ``name` .. _class_ClassDB_method_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +- :ref:`bool` **class_has_method** **(** :ref:`StringName` class, :ref:`StringName` method, :ref:`bool` no_inheritance=false **)** const Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) has a method called ``method`` or not. @@ -164,7 +164,7 @@ Returns whether ``class`` (or its ancestry if ``no_inheritance`` is ``false``) h .. _class_ClassDB_method_class_has_signal: -- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`bool` **class_has_signal** **(** :ref:`StringName` class, :ref:`StringName` signal **)** const Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. @@ -172,7 +172,7 @@ Returns whether ``class`` or its ancestry has a signal called ``signal`` or not. .. _class_ClassDB_method_class_set_property: -- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** const Sets ``property`` value of ``class`` to ``value``. @@ -180,7 +180,7 @@ Sets ``property`` value of ``class`` to ``value``. .. _class_ClassDB_method_get_class_list: -- :ref:`PoolStringArray` **get_class_list** **(** **)** const +- :ref:`PackedStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. @@ -188,7 +188,7 @@ Returns the names of all the classes available. .. _class_ClassDB_method_get_inheriters_from_class: -- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const +- :ref:`PackedStringArray` **get_inheriters_from_class** **(** :ref:`StringName` class **)** const Returns the names of all the classes that directly or indirectly inherit from ``class``. @@ -196,7 +196,7 @@ Returns the names of all the classes that directly or indirectly inherit from `` .. _class_ClassDB_method_get_parent_class: -- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const +- :ref:`StringName` **get_parent_class** **(** :ref:`StringName` class **)** const Returns the parent class of ``class``. @@ -204,7 +204,7 @@ Returns the parent class of ``class``. .. _class_ClassDB_method_instance: -- :ref:`Variant` **instance** **(** :ref:`String` class **)** const +- :ref:`Variant` **instance** **(** :ref:`StringName` class **)** const Creates an instance of ``class``. @@ -212,7 +212,7 @@ Creates an instance of ``class``. .. _class_ClassDB_method_is_class_enabled: -- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const +- :ref:`bool` **is_class_enabled** **(** :ref:`StringName` class **)** const Returns whether this ``class`` is enabled or not. @@ -220,7 +220,7 @@ Returns whether this ``class`` is enabled or not. .. _class_ClassDB_method_is_parent_class: -- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const +- :ref:`bool` **is_parent_class** **(** :ref:`StringName` class, :ref:`StringName` inherits **)** const Returns whether ``inherits`` is an ancestor of ``class`` or not. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 932a5e7d5..eef08d028 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -21,13 +21,13 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ -| :ref:`float` | :ref:`depth` | ``1.0`` | -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`disabled` | ``false`` | -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( )`` | -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`depth` | ``1.0`` | ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`disabled` | ``false`` | ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`polygon` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ Property Descriptions --------------------- @@ -66,15 +66,15 @@ If ``true``, no collision will be produced. .. _class_CollisionPolygon_property_polygon: -- :ref:`PoolVector2Array` **polygon** +- :ref:`PackedVector2Array` **polygon** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_polygon(value) | -+-----------+--------------------------+ -| *Getter* | get_polygon() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------------+ Array of vertices which define the polygon. diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 91dae95a8..2a1fde3c6 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -21,17 +21,17 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D` | :ref:`build_mode` | ``0`` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`disabled` | ``false`` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`one_way_collision` | ``false`` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+ -| :ref:`float` | :ref:`one_way_collision_margin` | ``1.0`` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( )`` | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ +| :ref:`BuildMode` | :ref:`build_mode` | ``0`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`disabled` | ``false`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`one_way_collision` | ``false`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`one_way_collision_margin` | ``1.0`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`polygon` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------+ Enumerations ------------ @@ -111,19 +111,21 @@ If ``true``, only edges that face up, relative to ``CollisionPolygon2D``'s rotat | *Getter* | get_one_way_collision_margin() | +-----------+-------------------------------------+ +The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity. + ---- .. _class_CollisionPolygon2D_property_polygon: -- :ref:`PoolVector2Array` **polygon** +- :ref:`PackedVector2Array` **polygon** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_polygon(value) | -+-----------+--------------------------+ -| *Getter* | get_polygon() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------------+ -The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PoolVector2Array`, not a reference. +The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the :ref:`PackedVector2Array`, not a reference. diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index a6436f0b5..0b6cc1530 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -83,7 +83,7 @@ Sets whether this collision shape should only detect collision on one side (top | *Getter* | get_one_way_collision_margin() | +-----------+-------------------------------------+ -The margin used for one-way collision (in pixels). +The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity. ---- diff --git a/classes/class_color.rst b/classes/class_color.rst index 50a96fc8d..f8bb8e033 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -48,53 +48,49 @@ Properties Methods ------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`contrasted` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gray` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`inverted` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Color` color **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_abgr32` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_abgr64` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_argb32` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_argb64` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_rgba32` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_rgba64` **(** **)** | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`contrasted` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1.0 **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`inverted` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Color` color **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr32` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_abgr64` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb32` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_argb64` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=true **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba32` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba64` **(** **)** | ++-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- -.. _class_Color_constant_gray: - .. _class_Color_constant_aliceblue: .. _class_Color_constant_antiquewhite: @@ -195,6 +191,8 @@ Constants .. _class_Color_constant_goldenrod: +.. _class_Color_constant_gray: + .. _class_Color_constant_green: .. _class_Color_constant_greenyellow: @@ -385,8 +383,6 @@ Constants .. _class_Color_constant_yellowgreen: -- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color. - - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** --- Alice blue color. - **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** --- Antique white color. @@ -487,6 +483,8 @@ Constants - **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** --- Goldenrod color. +- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color. + - **green** = **Color( 0, 1, 0, 1 )** --- Green color. - **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** --- Green yellow color. @@ -901,7 +899,7 @@ Returns a new color resulting from making this color darker by the specified per .. _class_Color_method_from_hsv: -- :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** +- :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1.0 **)** Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1. @@ -911,21 +909,6 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe ---- -.. _class_Color_method_gray: - -- :ref:`float` **gray** **(** **)** - -Returns the color's grayscale representation. - -The gray value is calculated as ``(r + g + b) / 3``. - -:: - - var c = Color(0.2, 0.45, 0.82) - var gray = c.gray() # A value of 0.466667 - ----- - .. _class_Color_method_inverted: - :ref:`Color` **inverted** **(** **)** @@ -1028,7 +1011,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon .. _class_Color_method_to_html: -- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** +- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=true **)** Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``). diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index ba305cbf9..1bb92c6b9 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -16,7 +16,7 @@ Color picker control. Description ----------- -:ref:`Control` node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. +Displays a color picker widget. Useful for selecting a color from an RGB/RGBA colorspace. Properties ---------- @@ -40,40 +40,40 @@ Properties Methods ------- -+---------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` color **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_preset` **(** :ref:`Color` color **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_preset` **(** :ref:`Color` color **)** | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`get_presets` **(** **)** const | ++-------------------------------------------------+--------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | add_preset | | -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | color_hue | | -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | color_sample | | -+-------------------------------+----------------------+-----+ -| :ref:`int` | h_width | 30 | -+-------------------------------+----------------------+-----+ -| :ref:`int` | label_width | 10 | -+-------------------------------+----------------------+-----+ -| :ref:`int` | margin | 4 | -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | overbright_indicator | | -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | preset_bg | | -+-------------------------------+----------------------+-----+ -| :ref:`Texture` | screen_picker | | -+-------------------------------+----------------------+-----+ -| :ref:`int` | sv_height | 256 | -+-------------------------------+----------------------+-----+ -| :ref:`int` | sv_width | 256 | -+-------------------------------+----------------------+-----+ ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | add_preset | | ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | color_hue | | ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | color_sample | | ++-----------------------------------+----------------------+-----+ +| :ref:`int` | h_width | 30 | ++-----------------------------------+----------------------+-----+ +| :ref:`int` | label_width | 10 | ++-----------------------------------+----------------------+-----+ +| :ref:`int` | margin | 4 | ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | overbright_indicator | | ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | preset_bg | | ++-----------------------------------+----------------------+-----+ +| :ref:`Texture2D` | screen_picker | | ++-----------------------------------+----------------------+-----+ +| :ref:`int` | sv_height | 256 | ++-----------------------------------+----------------------+-----+ +| :ref:`int` | sv_width | 256 | ++-----------------------------------+----------------------+-----+ Signals ------- @@ -240,7 +240,7 @@ Removes the given color from the list of color presets of this color picker. .. _class_ColorPicker_method_get_presets: -- :ref:`PoolColorArray` **get_presets** **(** **)** const +- :ref:`PackedColorArray` **get_presets** **(** **)** const Returns the list of colors in the presets of the color picker. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 7df14aeba..3422a300c 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -41,31 +41,31 @@ Methods Theme Properties ---------------- -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Texture` | bg | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`StyleBox` | disabled | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Font` | font | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Color` | font_color | Color( 1, 1, 1, 1 ) | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Color` | font_color_hover | Color( 1, 1, 1, 1 ) | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`Color` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`StyleBox` | hover | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`int` | hseparation | 2 | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+---------------------+-----------------------------+ -| :ref:`StyleBox` | pressed | | -+---------------------------------+---------------------+-----------------------------+ ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Texture2D` | bg | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | disabled | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color | Color( 1, 1, 1, 1 ) | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.3 ) | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_hover | Color( 1, 1, 1, 1 ) | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`Color` | font_color_pressed | Color( 0.8, 0.8, 0.8, 1 ) | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | hover | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`int` | hseparation | 2 | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+---------------------+-----------------------------+ +| :ref:`StyleBox` | pressed | | ++-----------------------------------+---------------------+-----------------------------+ Signals ------- diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 2f629ecd0..fd120921a 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -18,21 +18,23 @@ Description Concave polygon shape resource, which can be set into a :ref:`PhysicsBody` or area. This shape is created by feeding a list of triangles. +Note: when used for collision, ``ConcavePolygonShape`` is intended to work with static :ref:`PhysicsBody` nodes like :ref:`StaticBody` and will not work with :ref:`KinematicBody` or :ref:`RigidBody` with a mode other than Static. + Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_faces` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_faces` **(** :ref:`PackedVector3Array` faces **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ConcavePolygonShape_method_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PackedVector3Array` **get_faces** **(** **)** const Returns the faces (an array of triangles). @@ -40,7 +42,7 @@ Returns the faces (an array of triangles). .. _class_ConcavePolygonShape_method_set_faces: -- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** +- void **set_faces** **(** :ref:`PackedVector3Array` faces **)** Sets the faces (an array of triangles). diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 4b59d5a05..77acd0863 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -23,24 +23,24 @@ The main difference between a :ref:`ConvexPolygonShape2D` | :ref:`segments` | ``PoolVector2Array( )`` | -+-------------------------------------------------+----------------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`segments` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+----------------------------------------------------------------+----------------------------+ Property Descriptions --------------------- .. _class_ConcavePolygonShape2D_property_segments: -- :ref:`PoolVector2Array` **segments** +- :ref:`PackedVector2Array` **segments** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_segments(value) | -+-----------+--------------------------+ -| *Getter* | get_segments() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_segments(value) | ++-----------+----------------------------+ +| *Getter* | get_segments() | ++-----------+----------------------------+ The array of points that make up the ``ConcavePolygonShape2D``'s line segments. diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index b41145913..e0d775f0e 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -49,35 +49,37 @@ ConfigFiles can also contain manually written comment lines starting with a semi Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section` **(** :ref:`String` section **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_encrypted_pass` **(** :ref:`String` path, :ref:`String` pass **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_encrypted` **(** :ref:`String` path, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_encrypted_pass` **(** :ref:`String` path, :ref:`String` pass **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section` **(** :ref:`String` section **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_sections` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_encrypted` **(** :ref:`String` path, :ref:`PackedByteArray` key **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`parse` **(** :ref:`String` data **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_encrypted` **(** :ref:`String` path, :ref:`PackedByteArray` key **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_encrypted_pass` **(** :ref:`String` path, :ref:`String` password **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -86,7 +88,7 @@ Method Descriptions - void **erase_section** **(** :ref:`String` section **)** -Deletes the specified section along with all the key-value pairs inside. +Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. ---- @@ -94,19 +96,21 @@ Deletes the specified section along with all the key-value pairs inside. - void **erase_section_key** **(** :ref:`String` section, :ref:`String` key **)** +Deletes the specified key in a section. Raises an error if either the section or the key do not exist. + ---- .. _class_ConfigFile_method_get_section_keys: -- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const +- :ref:`PackedStringArray` **get_section_keys** **(** :ref:`String` section **)** const -Returns an array of all defined key identifiers in the specified section. +Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. ---- .. _class_ConfigFile_method_get_sections: -- :ref:`PoolStringArray` **get_sections** **(** **)** const +- :ref:`PackedStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. @@ -116,7 +120,7 @@ Returns an array of all defined section identifiers. - :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const -Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted. +Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback ``default`` value. If ``default`` is not specified or set to ``null``, an error is also raised. ---- @@ -140,7 +144,7 @@ Returns ``true`` if the specified section-key pair exists. - :ref:`Error` **load** **(** :ref:`String` path **)** -Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. +Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on. Returns one of the :ref:`Error` code constants (``OK`` on success). @@ -148,13 +152,31 @@ Returns one of the :ref:`Error` code constants (``OK`` .. _class_ConfigFile_method_load_encrypted: -- :ref:`Error` **load_encrypted** **(** :ref:`String` path, :ref:`PoolByteArray` key **)** +- :ref:`Error` **load_encrypted** **(** :ref:`String` path, :ref:`PackedByteArray` key **)** + +Loads the encrypted config file specified as a parameter, using the provided ``key`` to decrypt it. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on. + +Returns one of the :ref:`Error` code constants (``OK`` on success). ---- .. _class_ConfigFile_method_load_encrypted_pass: -- :ref:`Error` **load_encrypted_pass** **(** :ref:`String` path, :ref:`String` pass **)** +- :ref:`Error` **load_encrypted_pass** **(** :ref:`String` path, :ref:`String` password **)** + +Loads the encrypted config file specified as a parameter, using the provided ``password`` to decrypt it. The file's contents are parsed and loaded in the ``ConfigFile`` object which the method was called on. + +Returns one of the :ref:`Error` code constants (``OK`` on success). + +---- + +.. _class_ConfigFile_method_parse: + +- :ref:`Error` **parse** **(** :ref:`String` data **)** + +Parses the the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. + +Returns one of the :ref:`Error` code constants (``OK`` on success). ---- @@ -162,7 +184,7 @@ Returns one of the :ref:`Error` code constants (``OK`` - :ref:`Error` **save** **(** :ref:`String` path **)** -Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. +Saves the contents of the ``ConfigFile`` object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the :ref:`Error` code constants (``OK`` on success). @@ -170,13 +192,21 @@ Returns one of the :ref:`Error` code constants (``OK`` .. _class_ConfigFile_method_save_encrypted: -- :ref:`Error` **save_encrypted** **(** :ref:`String` path, :ref:`PoolByteArray` key **)** +- :ref:`Error` **save_encrypted** **(** :ref:`String` path, :ref:`PackedByteArray` key **)** + +Saves the contents of the ``ConfigFile`` object to the AES-256 encrypted file specified as a parameter, using the provided ``key`` to encrypt it. The output file uses an INI-style structure. + +Returns one of the :ref:`Error` code constants (``OK`` on success). ---- .. _class_ConfigFile_method_save_encrypted_pass: -- :ref:`Error` **save_encrypted_pass** **(** :ref:`String` path, :ref:`String` pass **)** +- :ref:`Error` **save_encrypted_pass** **(** :ref:`String` path, :ref:`String` password **)** + +Saves the contents of the ``ConfigFile`` object to the AES-256 encrypted file specified as a parameter, using the provided ``password`` to encrypt it. The output file uses an INI-style structure. + +Returns one of the :ref:`Error` code constants (``OK`` on success). ---- @@ -184,5 +214,5 @@ Returns one of the :ref:`Error` code constants (``OK`` - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** -Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. +Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/classes/class_container.rst b/classes/class_container.rst index e0110e2f5..b15656dec 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -22,6 +22,13 @@ Base node for containers. A ``Container`` contains other controls and automatica A Control can inherit this to create custom container classes. +Properties +---------- + ++----------------------------------------------+--------------+--------------+ +| :ref:`MouseFilter` | mouse_filter | **O:** ``1`` | ++----------------------------------------------+--------------+--------------+ + Methods ------- diff --git a/classes/class_control.rst b/classes/class_control.rst index 4ff55f871..5a670f560 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -122,17 +122,17 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`accept_event` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | +| void | :ref:`add_color_override` **(** :ref:`StringName` name, :ref:`Color` color **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | +| void | :ref:`add_constant_override` **(** :ref:`StringName` name, :ref:`int` constant **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | +| void | :ref:`add_font_override` **(** :ref:`StringName` name, :ref:`Font` font **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | +| void | :ref:`add_icon_override` **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | +| void | :ref:`add_shader_override` **(** :ref:`StringName` name, :ref:`Shader` shader **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | +| void | :ref:`add_stylebox_override` **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -144,11 +144,11 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_begin` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`int` | :ref:`get_constant` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -160,11 +160,11 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Font` | :ref:`get_font` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Texture2D` | :ref:`get_icon` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -178,7 +178,7 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -186,31 +186,31 @@ Methods +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_focus` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_color` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_constant` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_focus` **(** **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_font` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_icon` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`StringName` name **)** const | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`minimum_size_changed` **(** **)** | +----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1223,7 +1223,7 @@ Marks an input event as handled. Once you accept an input event, it stops propag .. _class_Control_method_add_color_override: -- void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** +- void **add_color_override** **(** :ref:`StringName` name, :ref:`Color` color **)** Overrides the :ref:`Color` with given ``name`` in the :ref:`theme` resource the control uses. If the ``color`` is empty or invalid, the override is cleared and the color from assigned :ref:`Theme` is used. @@ -1231,7 +1231,7 @@ Overrides the :ref:`Color` with given ``name`` in the :ref:`theme` name, :ref:`int` constant **)** +- void **add_constant_override** **(** :ref:`StringName` name, :ref:`int` constant **)** Overrides an integer constant with given ``name`` in the :ref:`theme` resource the control uses. If the ``constant`` is empty or invalid, the override is cleared and the constant from assigned :ref:`Theme` is used. @@ -1239,7 +1239,7 @@ Overrides an integer constant with given ``name`` in the :ref:`theme` name, :ref:`Font` font **)** +- void **add_font_override** **(** :ref:`StringName` name, :ref:`Font` font **)** Overrides the font with given ``name`` in the :ref:`theme` resource the control uses. If ``font`` is empty or invalid, the override is cleared and the font from assigned :ref:`Theme` is used. @@ -1247,7 +1247,7 @@ Overrides the font with given ``name`` in the :ref:`theme` name, :ref:`Texture` texture **)** +- void **add_icon_override** **(** :ref:`StringName` name, :ref:`Texture2D` texture **)** Overrides the icon with given ``name`` in the :ref:`theme` resource the control uses. If ``icon`` is empty or invalid, the override is cleared and the icon from assigned :ref:`Theme` is used. @@ -1255,7 +1255,7 @@ Overrides the icon with given ``name`` in the :ref:`theme` name, :ref:`Shader` shader **)** +- void **add_shader_override** **(** :ref:`StringName` name, :ref:`Shader` shader **)** Overrides the :ref:`Shader` with given ``name`` in the :ref:`theme` resource the control uses. If ``shader`` is empty or invalid, the override is cleared and the shader from assigned :ref:`Theme` is used. @@ -1263,7 +1263,7 @@ Overrides the :ref:`Shader` with given ``name`` in the :ref:`theme .. _class_Control_method_add_stylebox_override: -- void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** +- void **add_stylebox_override** **(** :ref:`StringName` name, :ref:`StyleBox` stylebox **)** Overrides the :ref:`StyleBox` with given ``name`` in the :ref:`theme` resource the control uses. If ``stylebox`` is empty or invalid, the override is cleared and the :ref:`StyleBox` from assigned :ref:`Theme` is used. @@ -1330,7 +1330,7 @@ Returns :ref:`margin_left` and :ref:`margin_ .. _class_Control_method_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Color` **get_color** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns a color from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1351,7 +1351,7 @@ Returns combined minimum size from :ref:`rect_min_size` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`int` **get_constant** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns a constant from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1408,7 +1408,7 @@ Returns the control that has the keyboard focus or ``null`` if none. .. _class_Control_method_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Font` **get_font** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns a font from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1424,7 +1424,7 @@ Returns the position and size of the control relative to the top-left corner of .. _class_Control_method_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Texture2D` **get_icon** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns an icon from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1480,7 +1480,7 @@ Returns the rotation (in radians). .. _class_Control_method_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns a :ref:`StyleBox` from assigned :ref:`Theme` with given ``name`` and associated with ``Control`` of given ``type``. @@ -1517,7 +1517,7 @@ Steal the focus from another control and become the focused control (see :ref:`f .. _class_Control_method_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_color** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns ``true`` if :ref:`Color` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1525,7 +1525,7 @@ Returns ``true`` if :ref:`Color` with given ``name`` and associated .. _class_Control_method_has_color_override: -- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_color_override** **(** :ref:`StringName` name **)** const Returns ``true`` if :ref:`Color` with given ``name`` has a valid override in this ``Control`` node. @@ -1533,7 +1533,7 @@ Returns ``true`` if :ref:`Color` with given ``name`` has a valid ov .. _class_Control_method_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_constant** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns ``true`` if constant with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1541,7 +1541,7 @@ Returns ``true`` if constant with given ``name`` and associated with ``Control`` .. _class_Control_method_has_constant_override: -- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_constant_override** **(** :ref:`StringName` name **)** const Returns ``true`` if constant with given ``name`` has a valid override in this ``Control`` node. @@ -1557,7 +1557,7 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_font** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns ``true`` if font with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1565,7 +1565,7 @@ Returns ``true`` if font with given ``name`` and associated with ``Control`` of .. _class_Control_method_has_font_override: -- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_font_override** **(** :ref:`StringName` name **)** const Returns ``true`` if font with given ``name`` has a valid override in this ``Control`` node. @@ -1573,7 +1573,7 @@ Returns ``true`` if font with given ``name`` has a valid override in this ``Cont .. _class_Control_method_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_icon** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns ``true`` if icon with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1581,7 +1581,7 @@ Returns ``true`` if icon with given ``name`` and associated with ``Control`` of .. _class_Control_method_has_icon_override: -- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_icon_override** **(** :ref:`StringName` name **)** const Returns ``true`` if icon with given ``name`` has a valid override in this ``Control`` node. @@ -1601,7 +1601,7 @@ If not overridden, default behavior is checking if the point is within control's .. _class_Control_method_has_shader_override: -- :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_shader_override** **(** :ref:`StringName` name **)** const Returns ``true`` if :ref:`Shader` with given ``name`` has a valid override in this ``Control`` node. @@ -1609,7 +1609,7 @@ Returns ``true`` if :ref:`Shader` with given ``name`` has a valid .. _class_Control_method_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type="" **)** const Returns ``true`` if :ref:`StyleBox` with given ``name`` and associated with ``Control`` of given ``type`` exists in assigned :ref:`Theme`. @@ -1617,7 +1617,7 @@ Returns ``true`` if :ref:`StyleBox` with given ``name`` and asso .. _class_Control_method_has_stylebox_override: -- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_stylebox_override** **(** :ref:`StringName` name **)** const Returns ``true`` if :ref:`StyleBox` with given ``name`` has a valid override in this ``Control`` node. diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 5301093a0..074667105 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -21,24 +21,24 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` | :ref:`points` | ``PoolVector3Array( )`` | -+-------------------------------------------------+---------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+---------------------------------------------------------+----------------------------+ +| :ref:`PackedVector3Array` | :ref:`points` | ``PackedVector3Array( )`` | ++-----------------------------------------------------+---------------------------------------------------------+----------------------------+ Property Descriptions --------------------- .. _class_ConvexPolygonShape_property_points: -- :ref:`PoolVector3Array` **points** +- :ref:`PackedVector3Array` **points** -+-----------+--------------------------+ -| *Default* | ``PoolVector3Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_points(value) | -+-----------+--------------------------+ -| *Getter* | get_points() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector3Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_points(value) | ++-----------+----------------------------+ +| *Getter* | get_points() | ++-----------+----------------------------+ The list of 3D points forming the convex polygon shape. diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 8cdcba319..28a335eb2 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -23,31 +23,31 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | ``PoolVector2Array( )`` | -+-------------------------------------------------+-----------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`points` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+-----------------------------------------------------------+----------------------------+ Methods ------- -+------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | -+------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_cloud` **(** :ref:`PackedVector2Array` point_cloud **)** | ++------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- .. _class_ConvexPolygonShape2D_property_points: -- :ref:`PoolVector2Array` **points** +- :ref:`PackedVector2Array` **points** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_points(value) | -+-----------+--------------------------+ -| *Getter* | get_points() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_points(value) | ++-----------+----------------------------+ +| *Getter* | get_points() | ++-----------+----------------------------+ The polygon's list of vertices. Can be in either clockwise or counterclockwise order. @@ -56,7 +56,7 @@ Method Descriptions .. _class_ConvexPolygonShape2D_method_set_point_cloud: -- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** +- void **set_point_cloud** **(** :ref:`PackedVector2Array` point_cloud **)** Based on the set of points provided, this creates and assigns the :ref:`points` property using the convex hull algorithm. Removing all unneeded points. See :ref:`Geometry.convex_hull_2d` for details. diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index 5a59ab007..b134467f1 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -23,135 +23,135 @@ See also :ref:`Particles`, which provides the same functionalit Properties ---------- -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :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_ramp` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`damping` | ``0.0`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Curve` | :ref:`damping_curve` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`damping_random` | ``0.0`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Vector3` | :ref:`direction` | ``Vector3( 1, 0, 0 )`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Vector3` | :ref:`emission_box_extents` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | ``PoolColorArray( )`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_normals` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`PoolVector3Array` | :ref:`emission_points` | ``PoolVector3Array( )`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :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:`flag_disable_z` | ``false`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`flag_rotate_y` | ``false`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`flatness` | ``0.0`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`fract_delta` | ``true`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Vector3` | :ref:`gravity` | ``Vector3( 0, -9.8, 0 )`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :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:`Mesh` | :ref:`mesh` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`one_shot` | ``false`` | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`orbit_velocity` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Curve` | :ref:`orbit_velocity_curve` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`orbit_velocity_random` | | -+-------------------------------------------------------+-------------------------------------------------------------------------------------+---------------------------+ -| :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:`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_ramp` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`damping` | ``0.0`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Curve` | :ref:`damping_curve` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`damping_random` | ``0.0`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector3` | :ref:`direction` | ``Vector3( 1, 0, 0 )`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector3` | :ref:`emission_box_extents` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedColorArray` | :ref:`emission_colors` | ``PackedColorArray( )`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector3Array` | :ref:`emission_normals` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector3Array` | :ref:`emission_points` | ``PackedVector3Array( )`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :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:`flag_disable_z` | ``false`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`flag_rotate_y` | ``false`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`flatness` | ``0.0`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`fract_delta` | ``true`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector3` | :ref:`gravity` | ``Vector3( 0, -9.8, 0 )`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :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:`Mesh` | :ref:`mesh` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`one_shot` | ``false`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`orbit_velocity` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Curve` | :ref:`orbit_velocity_curve` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`orbit_velocity_random` | | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ +| :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`` | ++-------------------------------------------------------+-------------------------------------------------------------------------------------+----------------------------+ Methods ------- @@ -634,10 +634,10 @@ The rectangle's extents if :ref:`emission_shape` **emission_colors** +- :ref:`PackedColorArray` **emission_colors** +-----------+----------------------------+ -| *Default* | ``PoolColorArray( )`` | +| *Default* | ``PackedColorArray( )`` | +-----------+----------------------------+ | *Setter* | set_emission_colors(value) | +-----------+----------------------------+ @@ -650,7 +650,7 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. _class_CPUParticles_property_emission_normals: -- :ref:`PoolVector3Array` **emission_normals** +- :ref:`PackedVector3Array` **emission_normals** +----------+-----------------------------+ | *Setter* | set_emission_normals(value) | @@ -664,10 +664,10 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. _class_CPUParticles_property_emission_points: -- :ref:`PoolVector3Array` **emission_points** +- :ref:`PackedVector3Array` **emission_points** +-----------+----------------------------+ -| *Default* | ``PoolVector3Array( )`` | +| *Default* | ``PackedVector3Array( )`` | +-----------+----------------------------+ | *Setter* | set_emission_points(value) | +-----------+----------------------------+ diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 036a9496b..0bbc053bd 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -69,11 +69,11 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ -| :ref:`PoolColorArray` | :ref:`emission_colors` | | +| :ref:`PackedColorArray` | :ref:`emission_colors` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_normals` | | +| :ref:`PackedVector2Array` | :ref:`emission_normals` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ -| :ref:`PoolVector2Array` | :ref:`emission_points` | | +| :ref:`PackedVector2Array` | :ref:`emission_points` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ | :ref:`Vector2` | :ref:`emission_rect_extents` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ @@ -115,7 +115,7 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`local_coords` | ``true`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`normalmap` | | +| :ref:`Texture2D` | :ref:`normalmap` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`one_shot` | ``false`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ @@ -151,7 +151,7 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`tangential_accel_random` | ``0.0`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------------+ Methods @@ -617,7 +617,7 @@ Particle draw order. Uses :ref:`DrawOrder` values .. _class_CPUParticles2D_property_emission_colors: -- :ref:`PoolColorArray` **emission_colors** +- :ref:`PackedColorArray` **emission_colors** +----------+----------------------------+ | *Setter* | set_emission_colors(value) | @@ -631,7 +631,7 @@ Sets the :ref:`Color`\ s to modulate particles by when using :ref:` .. _class_CPUParticles2D_property_emission_normals: -- :ref:`PoolVector2Array` **emission_normals** +- :ref:`PackedVector2Array` **emission_normals** +----------+-----------------------------+ | *Setter* | set_emission_normals(value) | @@ -645,7 +645,7 @@ Sets the direction the particles will be emitted in when using :ref:`EMISSION_SH .. _class_CPUParticles2D_property_emission_points: -- :ref:`PoolVector2Array` **emission_points** +- :ref:`PackedVector2Array` **emission_points** +----------+----------------------------+ | *Setter* | set_emission_points(value) | @@ -971,7 +971,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the .. _class_CPUParticles2D_property_normalmap: -- :ref:`Texture` **normalmap** +- :ref:`Texture2D` **normalmap** +----------+----------------------+ | *Setter* | set_normalmap(value) | @@ -1249,7 +1249,7 @@ Tangential acceleration randomness ratio. .. _class_CPUParticles2D_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index 8d7053e8b..c18c4954e 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -43,7 +43,7 @@ Methods ------- +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`generate_random_bytes` **(** :ref:`int` size **)** | +| :ref:`PackedByteArray` | :ref:`generate_random_bytes` **(** :ref:`int` size **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CryptoKey` | :ref:`generate_rsa` **(** :ref:`int` size **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,9 +55,9 @@ Method Descriptions .. _class_Crypto_method_generate_random_bytes: -- :ref:`PoolByteArray` **generate_random_bytes** **(** :ref:`int` size **)** +- :ref:`PackedByteArray` **generate_random_bytes** **(** :ref:`int` size **)** -Generates a :ref:`PoolByteArray` of cryptographically secure random bytes with given ``size``. +Generates a :ref:`PackedByteArray` of cryptographically secure random bytes with given ``size``. ---- diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index c8ed54440..43f5f2e82 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -21,33 +21,33 @@ This node takes a 2D polygon shape and extrudes it to create a 3D mesh. Properties ---------- -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`float` | :ref:`depth` | ``1.0`` | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`Material` | :ref:`material` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`Mode` | :ref:`mode` | ``0`` | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`path_continuous_u` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`float` | :ref:`path_interval` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`path_joined` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`path_local` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`NodePath` | :ref:`path_node` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`PathRotation` | :ref:`path_rotation` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`bool` | :ref:`smooth_faces` | ``false`` | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`float` | :ref:`spin_degrees` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ -| :ref:`int` | :ref:`spin_sides` | | -+---------------------------------------------------+-----------------------------------------------------------------------+------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`depth` | ``1.0`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`Material` | :ref:`material` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`Mode` | :ref:`mode` | ``0`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`path_continuous_u` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`path_interval` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`path_joined` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`path_local` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`NodePath` | :ref:`path_node` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`PathRotation` | :ref:`path_rotation` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`polygon` | ``PackedVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`bool` | :ref:`smooth_faces` | ``false`` | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`float` | :ref:`spin_degrees` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ +| :ref:`int` | :ref:`spin_sides` | | ++-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------------------------------+ Enumerations ------------ @@ -221,15 +221,15 @@ The method by which each slice is rotated along the path when :ref:`mode` **polygon** +- :ref:`PackedVector2Array` **polygon** -+-----------+------------------------------------------------+ -| *Default* | ``PoolVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` | -+-----------+------------------------------------------------+ -| *Setter* | set_polygon(value) | -+-----------+------------------------------------------------+ -| *Getter* | get_polygon() | -+-----------+------------------------------------------------+ ++-----------+--------------------------------------------------+ +| *Default* | ``PackedVector2Array( 0, 0, 0, 1, 1, 1, 1, 0 )`` | ++-----------+--------------------------------------------------+ +| *Setter* | set_polygon(value) | ++-----------+--------------------------------------------------+ +| *Getter* | get_polygon() | ++-----------+--------------------------------------------------+ Point array that defines the shape that we'll extrude. diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 5f92e9369..5436392df 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -16,14 +16,14 @@ CSharpScript Methods ------- -+-----------------------------+------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** ... **)** vararg | -+-----------------------------+------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | ++-------------------------------+------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_CSharpScript_method_new: -- :ref:`Object` **new** **(** ... **)** vararg +- :ref:`Variant` **new** **(** ... **)** vararg diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 61c7a7935..a2d6121a4 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -1,197 +1,15 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the CubeMap.xml source instead. +.. DO NOT EDIT THIS FILE, but the Cubemap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_CubeMap: +.. _class_Cubemap: -CubeMap +Cubemap ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -A CubeMap is a 6-sided 3D texture. -Description ------------ - -A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. - -Properties ----------- - -+--------------------------------------+----------------------------------------------------------------------------+---------+ -| :ref:`int` | :ref:`flags` | ``7`` | -+--------------------------------------+----------------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`lossy_storage_quality` | ``0.7`` | -+--------------------------------------+----------------------------------------------------------------------------+---------+ -| :ref:`Storage` | :ref:`storage_mode` | ``0`` | -+--------------------------------------+----------------------------------------------------------------------------+---------+ - -Methods -------- - -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_CubeMap_Storage: - -.. _class_CubeMap_constant_STORAGE_RAW: - -.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSY: - -.. _class_CubeMap_constant_STORAGE_COMPRESS_LOSSLESS: - -enum **Storage**: - -- **STORAGE_RAW** = **0** --- Store the ``CubeMap`` without any compression. - -- **STORAGE_COMPRESS_LOSSY** = **1** --- Store the ``CubeMap`` with strong compression that reduces image quality. - -- **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality. - ----- - -.. _enum_CubeMap_Side: - -.. _class_CubeMap_constant_SIDE_LEFT: - -.. _class_CubeMap_constant_SIDE_RIGHT: - -.. _class_CubeMap_constant_SIDE_BOTTOM: - -.. _class_CubeMap_constant_SIDE_TOP: - -.. _class_CubeMap_constant_SIDE_FRONT: - -.. _class_CubeMap_constant_SIDE_BACK: - -enum **Side**: - -- **SIDE_LEFT** = **0** --- Identifier for the left face of the ``CubeMap``. - -- **SIDE_RIGHT** = **1** --- Identifier for the right face of the ``CubeMap``. - -- **SIDE_BOTTOM** = **2** --- Identifier for the bottom face of the ``CubeMap``. - -- **SIDE_TOP** = **3** --- Identifier for the top face of the ``CubeMap``. - -- **SIDE_FRONT** = **4** --- Identifier for the front face of the ``CubeMap``. - -- **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``. - ----- - -.. _enum_CubeMap_Flags: - -.. _class_CubeMap_constant_FLAG_MIPMAPS: - -.. _class_CubeMap_constant_FLAG_REPEAT: - -.. _class_CubeMap_constant_FLAG_FILTER: - -.. _class_CubeMap_constant_FLAGS_DEFAULT: - -enum **Flags**: - -- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture. - -- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge). - -- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. - -- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. - -Property Descriptions ---------------------- - -.. _class_CubeMap_property_flags: - -- :ref:`int` **flags** - -+-----------+------------------+ -| *Default* | ``7`` | -+-----------+------------------+ -| *Setter* | set_flags(value) | -+-----------+------------------+ -| *Getter* | get_flags() | -+-----------+------------------+ - -The render flags for the ``CubeMap``. See the :ref:`Flags` constants for details. - ----- - -.. _class_CubeMap_property_lossy_storage_quality: - -- :ref:`float` **lossy_storage_quality** - -+-----------+----------------------------------+ -| *Default* | ``0.7`` | -+-----------+----------------------------------+ -| *Setter* | set_lossy_storage_quality(value) | -+-----------+----------------------------------+ -| *Getter* | get_lossy_storage_quality() | -+-----------+----------------------------------+ - -The lossy storage quality of the ``CubeMap`` if the storage mode is set to :ref:`STORAGE_COMPRESS_LOSSY`. - ----- - -.. _class_CubeMap_property_storage_mode: - -- :ref:`Storage` **storage_mode** - -+-----------+--------------------+ -| *Default* | ``0`` | -+-----------+--------------------+ -| *Setter* | set_storage(value) | -+-----------+--------------------+ -| *Getter* | get_storage() | -+-----------+--------------------+ - -The ``CubeMap``'s storage mode. See :ref:`Storage` constants. - -Method Descriptions -------------------- - -.. _class_CubeMap_method_get_height: - -- :ref:`int` **get_height** **(** **)** const - -Returns the ``CubeMap``'s height. - ----- - -.. _class_CubeMap_method_get_side: - -- :ref:`Image` **get_side** **(** :ref:`Side` side **)** const - -Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the :ref:`Side` constants. - ----- - -.. _class_CubeMap_method_get_width: - -- :ref:`int` **get_width** **(** **)** const - -Returns the ``CubeMap``'s width. - ----- - -.. _class_CubeMap_method_set_side: - -- void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** - -Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the :ref:`Side` constants. diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst new file mode 100644 index 000000000..1dc6b8496 --- /dev/null +++ b/classes/class_cubemaparray.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CubemapArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CubemapArray: + +CubemapArray +============ + +**Inherits:** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + + + diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index efbe49930..0ae2a55a3 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -30,43 +30,43 @@ Properties Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_baked_points` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -116,9 +116,9 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve2D_method_get_baked_points: -- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const +- :ref:`PackedVector2Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`PoolVector2Array`. +Returns the cache of points as a :ref:`PackedVector2Array`. ---- @@ -238,7 +238,7 @@ Sets the position for the vertex ``idx``. If the index is out of bounds, the fun .. _class_Curve2D_method_tessellate: -- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PackedVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 27db98d1d..003c7ad7b 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -32,53 +32,53 @@ Properties Methods ------- -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_baked_points` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`get_baked_tilts` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -144,25 +144,25 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve3D_method_get_baked_points: -- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const +- :ref:`PackedVector3Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`PoolVector3Array`. +Returns the cache of points as a :ref:`PackedVector3Array`. ---- .. _class_Curve3D_method_get_baked_tilts: -- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const +- :ref:`PackedFloat32Array` **get_baked_tilts** **(** **)** const -Returns the cache of tilts as a :ref:`PoolRealArray`. +Returns the cache of tilts as a :ref:`PackedFloat32Array`. ---- .. _class_Curve3D_method_get_baked_up_vectors: -- :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const +- :ref:`PackedVector3Array` **get_baked_up_vectors** **(** **)** const -Returns the cache of up vectors as a :ref:`PoolVector3Array`. +Returns the cache of up vectors as a :ref:`PackedVector3Array`. If :ref:`up_vector_enabled` is ``false``, the cache will be empty. @@ -314,7 +314,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa .. _class_Curve3D_method_tessellate: -- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PackedVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index fbdcaef43..7e6495d8d 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -9,7 +9,7 @@ CurveTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` A texture that shows a curve. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index aa4bc7104..f8f084c7c 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -98,13 +98,13 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | +| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=false **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** | +| void | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -132,7 +132,7 @@ Clear the dictionary, removing all key/value pairs. .. _class_Dictionary_method_duplicate: -- :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** +- :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=false **)** Creates a copy of the dictionary, and returns it. @@ -156,7 +156,7 @@ Erase a dictionary key/value pair by key. Returns ``true`` if the given key was .. _class_Dictionary_method_get: -- :ref:`Variant` **get** **(** :ref:`Variant` key, :ref:`Variant` default=Null **)** +- void **get** **(** :ref:`Variant` key, :ref:`Variant` default=null **)** Returns the current value for the specified key in the ``Dictionary``. If the key does not exist, the method returns the value of the optional default argument, or ``null`` if it is omitted. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index fd571aad8..0a0e379b2 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -33,6 +33,8 @@ 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`` | @@ -132,6 +134,20 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang ---- +.. _class_DirectionalLight_property_directional_shadow_fade_start: + +- :ref:`float` **directional_shadow_fade_start** + ++-----------+------------------+ +| *Default* | ``0.8`` | ++-----------+------------------+ +| *Setter* | set_param(value) | ++-----------+------------------+ +| *Getter* | get_param() | ++-----------+------------------+ + +---- + .. _class_DirectionalLight_property_directional_shadow_max_distance: - :ref:`float` **directional_shadow_max_distance** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 67a0cd760..e7be3a88b 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -57,7 +57,7 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** | +| :ref:`String` | :ref:`get_current_dir` **(** :ref:`bool` include_drive=true **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_drive` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,10 +133,12 @@ Returns whether the target file exists. The argument can be relative to the curr .. _class_Directory_method_get_current_dir: -- :ref:`String` **get_current_dir** **(** **)** +- :ref:`String` **get_current_dir** **(** :ref:`bool` include_drive=true **)** Returns the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). +On Windows, if ``include_drive`` is ``false``, the leading drive specificator is omitted from the returned value (e.g. ``\tmp\folder``). + ---- .. _class_Directory_method_get_current_drive: diff --git a/classes/class_dtlsserver.rst b/classes/class_dtlsserver.rst new file mode 100644 index 000000000..3a9cbb267 --- /dev/null +++ b/classes/class_dtlsserver.rst @@ -0,0 +1,103 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the DTLSServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_DTLSServer: + +DTLSServer +========== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +Helper class to implement a DTLS server. + +Description +----------- + +This class is used to store the state of a DTLS server. Upon :ref:`setup` it converts connected :ref:`PacketPeerUDP` to :ref:`PacketPeerDTLS` accepting them via :ref:`take_connection` as DTLS clients. Under the hood, this class is used to store the DTLS state and cookies of the server. The reason of why the state and cookies are needed is outside of the scope of this documentation. + +Below a small example of how to use it: + +:: + + # server.gd + extends Node + + var dtls := DTLSServer.new() + var server := UDPServer.new() + var peers = [] + + func _ready(): + server.listen(4242) + var key = load("key.key") # Your private key. + var cert = load("cert.crt") # Your X509 certificate. + dtls.setup(key, cert) + + func _process(delta): + while server.is_connection_available(): + var peer : PacketPeerUDP = server.take_connection() + var dtls_peer : PacketPeerDTLS = dtls.take_connection(peer) + if dtls_peer.get_status() != PacketPeerDTLS.STATUS_HANDSHAKING: + continue # It is normal that 50% of the connections fails due to cookie exchange. + print("Peer connected!") + peers.append(dtls_peer) + for p in peers: + p.poll() # Must poll to update the state. + if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED: + while p.get_available_packet_count() > 0: + print("Received message from client: %s" % p.get_packet().get_string_from_utf8()) + p.put_packet("Hello DTLS client".to_utf8()) + +:: + + # client.gd + extends Node + + var dtls := PacketPeerDTLS.new() + var udp := PacketPeerUDP.new() + var connected = false + + func _ready(): + udp.connect_to_host("127.0.0.1", 4242) + dtls.connect_to_peer(udp, false) # Use true in production for certificate validation! + + func _process(delta): + dtls.poll() + if dtls.get_status() == PacketPeerDTLS.STATUS_CONNECTED: + if !connected: + # Try to contact server + dtls.put_packet("The answer is... 42!".to_utf8()) + while dtls.get_available_packet_count() > 0: + print("Connected: %s" % dtls.get_packet().get_string_from_utf8()) + connected = true + +Methods +------- + ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`setup` **(** :ref:`CryptoKey` key, :ref:`X509Certificate` certificate, :ref:`X509Certificate` chain=null **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PacketPeerDTLS` | :ref:`take_connection` **(** :ref:`PacketPeerUDP` udp_peer **)** | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_DTLSServer_method_setup: + +- :ref:`Error` **setup** **(** :ref:`CryptoKey` key, :ref:`X509Certificate` certificate, :ref:`X509Certificate` chain=null **)** + +Setup the DTLS server to use the given ``private_key`` and provide the given ``certificate`` to clients. You can pass the optional ``chain`` parameter to provide additional CA chain information along with the certificate. + +---- + +.. _class_DTLSServer_method_take_connection: + +- :ref:`PacketPeerDTLS` **take_connection** **(** :ref:`PacketPeerUDP` udp_peer **)** + +Try to initiate the DTLS handshake with the given ``udp_peer`` which must be already connected (see :ref:`PacketPeerUDP.connect_to_host`). + +**Note**: You must check that the state of the return PacketPeerUDP is :ref:`PacketPeerDTLS.STATUS_HANDSHAKING`, as it is normal that 50% of the new connections will be invalid due to cookie exchange. + diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index dd9da2857..a023ab6b3 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -47,10 +47,6 @@ Properties +-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`size` | ``16`` | +-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`use_filter` | ``false`` | -+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`use_mipmaps` | ``false`` | -+-----------------------------------------------+------------------------------------------------------------------------------+-------------------------+ Methods ------- @@ -223,38 +219,6 @@ The font outline's thickness in pixels (not relative to the font size). The font size in pixels. ----- - -.. _class_DynamicFont_property_use_filter: - -- :ref:`bool` **use_filter** - -+-----------+-----------------------+ -| *Default* | ``false`` | -+-----------+-----------------------+ -| *Setter* | set_use_filter(value) | -+-----------+-----------------------+ -| *Getter* | get_use_filter() | -+-----------+-----------------------+ - -If ``true``, filtering is used. This makes the font blurry instead of pixelated when scaling it if font oversampling is disabled or ineffective. It's recommended to enable this when using the font in a control whose size changes over time, unless a pixel art aesthetic is desired. - ----- - -.. _class_DynamicFont_property_use_mipmaps: - -- :ref:`bool` **use_mipmaps** - -+-----------+------------------------+ -| *Default* | ``false`` | -+-----------+------------------------+ -| *Setter* | set_use_mipmaps(value) | -+-----------+------------------------+ -| *Getter* | get_use_mipmaps() | -+-----------+------------------------+ - -If ``true``, mipmapping is used. This improves the font's appearance when downscaling it if font oversampling is disabled or ineffective. - Method Descriptions ------------------- diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 5dd8528b6..41741d828 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -11,41 +11,43 @@ EditorExportPlugin **Inherits:** :ref:`Reference` **<** :ref:`Object` - +A script that is executed when exporting projects. Methods ------- -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_end` **(** **)** virtual | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_end` **(** **)** virtual | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** virtual | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorExportPlugin_method__export_begin: -- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual +- void **_export_begin** **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual + +Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. ---- @@ -53,17 +55,19 @@ Method Descriptions - void **_export_end** **(** **)** virtual +Virtual method to be overridden by the user. Called when the export is finished. + ---- .. _class_EditorExportPlugin_method__export_file: -- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual +- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** virtual ---- .. _class_EditorExportPlugin_method_add_file: -- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** +- void **add_file** **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** ---- @@ -99,7 +103,7 @@ Method Descriptions .. _class_EditorExportPlugin_method_add_shared_object: -- void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** +- void **add_shared_object** **(** :ref:`String` path, :ref:`PackedStringArray` tags **)** ---- diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst index 86982ba69..527f2983a 100644 --- a/classes/class_editorfeatureprofile.rst +++ b/classes/class_editorfeatureprofile.rst @@ -16,29 +16,29 @@ EditorFeatureProfile Methods ------- -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` property **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class` **(** :ref:`String` class_name, :ref:`bool` disable **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class_editor` **(** :ref:`String` class_name, :ref:`bool` disable **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_class_property` **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` disable **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | -+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`StringName` class_name **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`StringName` class_name **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`StringName` class_name, :ref:`StringName` property **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class` **(** :ref:`StringName` class_name, :ref:`bool` disable **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_editor` **(** :ref:`StringName` class_name, :ref:`bool` disable **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_property` **(** :ref:`StringName` class_name, :ref:`StringName` property, :ref:`bool` disable **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -90,19 +90,19 @@ Method Descriptions .. _class_EditorFeatureProfile_method_is_class_disabled: -- :ref:`bool` **is_class_disabled** **(** :ref:`String` class_name **)** const +- :ref:`bool` **is_class_disabled** **(** :ref:`StringName` class_name **)** const ---- .. _class_EditorFeatureProfile_method_is_class_editor_disabled: -- :ref:`bool` **is_class_editor_disabled** **(** :ref:`String` class_name **)** const +- :ref:`bool` **is_class_editor_disabled** **(** :ref:`StringName` class_name **)** const ---- .. _class_EditorFeatureProfile_method_is_class_property_disabled: -- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` property **)** const +- :ref:`bool` **is_class_property_disabled** **(** :ref:`StringName` class_name, :ref:`StringName` property **)** const ---- @@ -126,19 +126,19 @@ Method Descriptions .. _class_EditorFeatureProfile_method_set_disable_class: -- void **set_disable_class** **(** :ref:`String` class_name, :ref:`bool` disable **)** +- void **set_disable_class** **(** :ref:`StringName` class_name, :ref:`bool` disable **)** ---- .. _class_EditorFeatureProfile_method_set_disable_class_editor: -- void **set_disable_class_editor** **(** :ref:`String` class_name, :ref:`bool` disable **)** +- void **set_disable_class_editor** **(** :ref:`StringName` class_name, :ref:`bool` disable **)** ---- .. _class_EditorFeatureProfile_method_set_disable_class_property: -- void **set_disable_class_property** **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` disable **)** +- void **set_disable_class_property** **(** :ref:`StringName` class_name, :ref:`StringName` property, :ref:`bool` disable **)** ---- diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index a2fddb4d7..46cea4292 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -11,7 +11,7 @@ EditorFileDialog **Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +A modified version of :ref:`FileDialog` used by the editor. Properties ---------- @@ -74,7 +74,7 @@ Emitted when a file is selected. .. _class_EditorFileDialog_signal_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PackedStringArray` paths **)** Emitted when multiple files are selected. diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index e08ce3e5e..ef79871a6 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -54,7 +54,7 @@ Emitted if the filesystem changed. .. _class_EditorFileSystem_signal_resources_reimported: -- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** +- **resources_reimported** **(** :ref:`PackedStringArray` resources **)** Remitted if a resource is reimported. @@ -62,7 +62,7 @@ Remitted if a resource is reimported. .. _class_EditorFileSystem_signal_resources_reload: -- **resources_reload** **(** :ref:`PoolStringArray` resources **)** +- **resources_reload** **(** :ref:`PackedStringArray` resources **)** ---- @@ -143,3 +143,5 @@ Update a file information. Call this if an external program (not Godot) modified - void **update_script_classes** **(** **)** +Scans the script files and updates the list of custom class names. + diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 749bc26d8..3945944bb 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -38,7 +38,7 @@ Methods +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | +| :ref:`StringName` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,7 +116,7 @@ Returns the path to the file at index ``idx``. .. _class_EditorFileSystemDirectory_method_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_file_type** **(** :ref:`int` idx **)** const Returns the file extension of the file at index ``idx``. diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 1d339d1e7..1ee232af3 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -11,7 +11,12 @@ EditorInspector **Inherits:** :ref:`ScrollContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +A tab used to edit properties of the selected node. +Description +----------- + +The editor inspector is by default located on the right-hand side of the editor. It's used to edit the properties of the selected node. For example, you can select a node such as the Sprite2D then edit its transform through the inspector tool. The editor inspector is an essential tool in the game development workflow. Properties ---------- diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index c9d8ed2e8..8d3069af6 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -38,7 +38,7 @@ Methods +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** | +| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PackedStringArray` properties, :ref:`Control` editor **)** | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_handle` **(** :ref:`Object` object **)** virtual | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Adds a property editor, this must inherit :ref:`EditorProperty` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** +- void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PackedStringArray` properties, :ref:`Control` editor **)** Adds an editor that allows modifying multiple properties, this must inherit :ref:`EditorProperty`. diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 88825766d..4f4c28494 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -192,7 +192,7 @@ Returns the enabled status of a plugin. The plugin name is the same as its direc - :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** -Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture`\ s. +Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture2D`\ s. ---- diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 5dbdc1c4f..9b409d040 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -35,7 +35,7 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture2D` icon **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -71,11 +71,11 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +| :ref:`PackedStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | +| :ref:`Texture2D` | :ref:`get_plugin_icon` **(** **)** virtual | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -307,11 +307,11 @@ When your plugin is deactivated, make sure to remove your custom control with :r .. _class_EditorPlugin_method_add_custom_type: -- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** +- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture2D` icon **)** Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. -When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. +When given node or resource is selected, the base type will be instanced (e.g. "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. You can use the virtual method :ref:`handles` to check if your custom object is being edited by checking the script or using the ``is`` keyword. @@ -479,7 +479,7 @@ Must ``return false`` in order to forward the :ref:`InputEvent .. _class_EditorPlugin_method_get_breakpoints: -- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual +- :ref:`PackedStringArray` **get_breakpoints** **(** **)** virtual This is for editors that edit script-based objects. You can return a list of breakpoints in the format (``script:line``), for example: ``res://path_to_script.gd:25``. @@ -495,7 +495,21 @@ Returns the :ref:`EditorInterface` object that gives you .. _class_EditorPlugin_method_get_plugin_icon: -- :ref:`Object` **get_plugin_icon** **(** **)** virtual +- :ref:`Texture2D` **get_plugin_icon** **(** **)** virtual + +Override this method in your plugin to return a :ref:`Texture2D` in order to give it an icon. + +For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. + +Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size. + +:: + + func get_plugin_icon(): + # You can use a custom icon: + return preload("res://addons/my_plugin/my_plugin_icon.svg") + # Or use a built-in icon: + return get_editor_interface().get_base_control().get_icon("Node", "EditorIcons") ---- @@ -503,6 +517,10 @@ Returns the :ref:`EditorInterface` object that gives you - :ref:`String` **get_plugin_name** **(** **)** virtual +Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. + +For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. + ---- .. _class_EditorPlugin_method_get_script_create_dialog: diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 105a7b68a..8452bd530 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -38,28 +38,28 @@ Properties Methods ------- -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_focusable` **(** :ref:`Control` control **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_changed` **(** :ref:`String` property, :ref:`Variant` value, :ref:`String` field="", :ref:`bool` changing=false **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_object` **(** **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_edited_property` **(** **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bottom_editor` **(** :ref:`Control` editor **)** | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_property` **(** **)** virtual | -+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_focusable` **(** :ref:`Control` control **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit_changed` **(** :ref:`StringName` property, :ref:`Variant` value, :ref:`StringName` field=@"", :ref:`bool` changing=false **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_edited_object` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_edited_property` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bottom_editor` **(** :ref:`Control` editor **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_property` **(** **)** virtual | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_EditorProperty_signal_multiple_properties_changed: -- **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** +- **multiple_properties_changed** **(** :ref:`PackedStringArray` properties, :ref:`Array` value **)** Emit it if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin.parse_property`. @@ -67,7 +67,7 @@ Emit it if you want multiple properties modified at the same time. Do not use if .. _class_EditorProperty_signal_object_id_selected: -- **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** +- **object_id_selected** **(** :ref:`StringName` property, :ref:`int` id **)** Used by sub-inspectors. Emit it if what was selected was an Object ID. @@ -75,7 +75,7 @@ Used by sub-inspectors. Emit it if what was selected was an Object ID. .. _class_EditorProperty_signal_property_changed: -- **property_changed** **(** :ref:`String` property, :ref:`Variant` value **)** +- **property_changed** **(** :ref:`StringName` property, :ref:`Variant` value **)** Do not emit this manually, use the :ref:`emit_changed` method instead. @@ -83,7 +83,7 @@ Do not emit this manually, use the :ref:`emit_changed` property, :ref:`String` bool **)** +- **property_checked** **(** :ref:`StringName` property, :ref:`String` bool **)** Emitted when a property was checked. Used internally. @@ -91,7 +91,7 @@ Emitted when a property was checked. Used internally. .. _class_EditorProperty_signal_property_keyed: -- **property_keyed** **(** :ref:`String` property **)** +- **property_keyed** **(** :ref:`StringName` property **)** Emit it if you want to add this value as an animation key (check for keying being enabled first). @@ -99,7 +99,7 @@ Emit it if you want to add this value as an animation key (check for keying bein .. _class_EditorProperty_signal_property_keyed_with_value: -- **property_keyed_with_value** **(** :ref:`String` property, :ref:`Variant` value **)** +- **property_keyed_with_value** **(** :ref:`StringName` property, :ref:`Variant` value **)** Emit it if you want to key a property with a single value. @@ -229,7 +229,7 @@ If any of the controls added can gain keyboard focus, add it here. This ensures .. _class_EditorProperty_method_emit_changed: -- void **emit_changed** **(** :ref:`String` property, :ref:`Variant` value, :ref:`String` field="", :ref:`bool` changing=false **)** +- void **emit_changed** **(** :ref:`StringName` property, :ref:`Variant` value, :ref:`StringName` field=@"", :ref:`bool` changing=false **)** If one or several properties have changed, this must be called. ``field`` is used in case your editor can modify fields separately (as an example, Vector3.x). The ``changing`` argument avoids the editor requesting this property to be refreshed (leave as ``false`` if unsure). @@ -245,7 +245,7 @@ Gets the edited object. .. _class_EditorProperty_method_get_edited_property: -- :ref:`String` **get_edited_property** **(** **)** +- :ref:`StringName` **get_edited_property** **(** **)** Gets the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin.parse_property`), then this will return the property. diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index b9c9122d0..b7ae4ecba 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -21,17 +21,17 @@ This object is used to generate previews for resources of files. Methods ------- -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | -+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | ++------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -63,7 +63,7 @@ Check if the resource changed, if so, it will be invalidated and the correspondi .. _class_EditorResourcePreview_method_queue_edited_resource_preview: -- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. @@ -71,7 +71,7 @@ Queue a resource being edited for preview (using an instance). Once the preview .. _class_EditorResourcePreview_method_queue_resource_preview: -- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`StringName` receiver_func, :ref:`Variant` userdata **)** Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 61de3a0b2..839e4f57e 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -21,17 +21,17 @@ Custom code to generate previews. Please check ``file_dialog/thumbnail_size`` in Methods ------- -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_generate_small_preview` **(** **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generate_small_preview_automatically` **(** **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_generate_small_preview` **(** **)** virtual | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** virtual | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generate_small_preview_automatically` **(** **)** virtual | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -48,7 +48,7 @@ By default, it returns ``false``. .. _class_EditorResourcePreviewGenerator_method_generate: -- :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual +- :ref:`Texture2D` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual Generate a preview from a given resource with the specified size. This must always be implemented. @@ -60,7 +60,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_method_generate_from_path: -- :ref:`Texture` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** virtual +- :ref:`Texture2D` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** virtual Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`generate`. diff --git a/classes/class_editorsceneimporterassimp.rst b/classes/class_editorsceneimporterassimp.rst index 95db30a64..71b10669b 100644 --- a/classes/class_editorsceneimporterassimp.rst +++ b/classes/class_editorsceneimporterassimp.rst @@ -11,12 +11,12 @@ EditorSceneImporterAssimp **Inherits:** :ref:`EditorSceneImporter` **<** :ref:`Reference` **<** :ref:`Object` -Multi-format 3D asset importer based on `Assimp `_. +FBX 3D asset importer based on `Assimp `_. Description ----------- -This is a multi-format 3D asset importer based on `Assimp `_. See `this page `_ for a full list of supported formats. +This is an FBX 3D asset importer based on `Assimp `_. It currently has many known limitations and works best with static meshes. Most animated meshes won't import correctly. If exporting a FBX scene from Autodesk Maya, use these FBX export settings: diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 6a80bdb7c..992ab0ad1 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -29,39 +29,39 @@ Accessing the settings is done by using the regular :ref:`Object` Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`String` property **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_favorites` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_project_settings_dir` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_settings_dir` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorites` **(** :ref:`PoolStringArray` dirs **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`String` property **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_favorites` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_project_settings_dir` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_recent_dirs` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_settings_dir` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_favorites` **(** :ref:`PackedStringArray` dirs **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`StringName` name, :ref:`Variant` value, :ref:`bool` update_current **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_recent_dirs` **(** :ref:`PackedStringArray` dirs **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -121,7 +121,7 @@ Erase a given setting (pass full property path). .. _class_EditorSettings_method_get_favorites: -- :ref:`PoolStringArray` **get_favorites** **(** **)** const +- :ref:`PackedStringArray` **get_favorites** **(** **)** const Gets the list of favorite files and directories for this project. @@ -143,7 +143,7 @@ Gets the specific project settings path. Projects all have a unique sub-director .. _class_EditorSettings_method_get_recent_dirs: -- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const +- :ref:`PackedStringArray` **get_recent_dirs** **(** **)** const Gets the list of recently visited folders in the file dialog for this project. @@ -187,7 +187,7 @@ Gets the global settings path for the engine. Inside this path, you can find som .. _class_EditorSettings_method_set_favorites: -- void **set_favorites** **(** :ref:`PoolStringArray` dirs **)** +- void **set_favorites** **(** :ref:`PackedStringArray` dirs **)** Sets the list of favorite files and directories for this project. @@ -195,7 +195,7 @@ Sets the list of favorite files and directories for this project. .. _class_EditorSettings_method_set_initial_value: -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** +- void **set_initial_value** **(** :ref:`StringName` name, :ref:`Variant` value, :ref:`bool` update_current **)** ---- @@ -207,7 +207,7 @@ Sets the list of favorite files and directories for this project. .. _class_EditorSettings_method_set_recent_dirs: -- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_recent_dirs** **(** :ref:`PackedStringArray` dirs **)** Sets the list of recently visited folders in the file dialog for this project. diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index d3152d2f0..b38b03294 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -21,48 +21,48 @@ Custom gizmo that is used for providing custom visualization and editing (handle Methods ------- -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`SkinReference` skeleton=null, :ref:`Material` material=null **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSpatialGizmoPlugin` | :ref:`get_plugin` **(** **)** const | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_spatial_node` **(** **)** const | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`int` index **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redraw` **(** **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | -+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_segments` **(** :ref:`PackedVector3Array` segments **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_handles` **(** :ref:`PackedVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_lines` **(** :ref:`PackedVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`SkinReference` skeleton=null, :ref:`Material` material=null **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorSpatialGizmoPlugin` | :ref:`get_plugin` **(** **)** const | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Spatial` | :ref:`get_spatial_node` **(** **)** const | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_handle_highlighted` **(** :ref:`int` index **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redraw` **(** **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | ++-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_EditorSpatialGizmo_method_add_collision_segments: -- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** +- void **add_collision_segments** **(** :ref:`PackedVector3Array` segments **)** ---- @@ -76,7 +76,7 @@ Adds collision triangles to the gizmo for picking. A :ref:`TriangleMesh` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PackedVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Adds a list of handles (points) which can be used to deform the object being edited. @@ -86,7 +86,7 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_method_add_lines: -- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** +- void **add_lines** **(** :ref:`PackedVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 1bfd05433..b72169332 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -27,7 +27,7 @@ Methods ------- +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_material` **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** | +| void | :ref:`add_material` **(** :ref:`String` name, :ref:`StandardMaterial3D` material **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_be_hidden` **(** **)** virtual | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,7 +37,7 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_handle_material` **(** :ref:`String` name, :ref:`bool` billboard=false **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_icon_material` **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** | +| void | :ref:`create_icon_material` **(** :ref:`String` name, :ref:`Texture2D` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_material` **(** :ref:`String` name, :ref:`Color` color, :ref:`bool` billboard=false, :ref:`bool` on_top=false, :ref:`bool` use_vertex_color=false **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,7 +45,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 **)** | +| :ref:`StandardMaterial3D` | :ref:`get_material` **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** virtual | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,7 +67,7 @@ Method Descriptions .. _class_EditorSpatialGizmoPlugin_method_add_material: -- void **add_material** **(** :ref:`String` name, :ref:`SpatialMaterial` material **)** +- void **add_material** **(** :ref:`String` name, :ref:`StandardMaterial3D` 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. @@ -107,7 +107,7 @@ Creates a handle material with its variants (selected and/or editable) and adds .. _class_EditorSpatialGizmoPlugin_method_create_icon_material: -- void **create_icon_material** **(** :ref:`String` name, :ref:`Texture` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** +- void **create_icon_material** **(** :ref:`String` name, :ref:`Texture2D` texture, :ref:`bool` on_top=false, :ref:`Color` color=Color( 1, 1, 1, 1 ) **)** Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with :ref:`get_material` and used in :ref:`EditorSpatialGizmo.add_unscaled_billboard`. Should not be overridden. @@ -139,7 +139,7 @@ Gets actual value of a handle from gizmo. Called for this plugin's active gizmos .. _class_EditorSpatialGizmoPlugin_method_get_material: -- :ref:`SpatialMaterial` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** +- :ref:`StandardMaterial3D` **get_material** **(** :ref:`String` name, :ref:`EditorSpatialGizmo` gizmo **)** 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_engine.rst b/classes/class_engine.rst index 4e70397bd..c872fc62c 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -99,7 +99,7 @@ If ``true``, it is running inside the editor. Useful for tool scripts. | *Getter* | get_iterations_per_second() | +-----------+----------------------------------+ -The number of fixed iterations per second (for fixed process and physics). +The number of fixed iterations per second. This controls how often physics simulation and :ref:`Node._physics_process` methods are run. This value should generally always be set to ``60`` or above, as Godot doesn't interpolate the physics step. As a result, values lower than ``60`` will look stuttery. This value can be increased to make input more reactive or work around tunneling issues, but keep in mind doing so will increase CPU usage. ---- @@ -115,7 +115,7 @@ The number of fixed iterations per second (for fixed process and physics). | *Getter* | get_physics_jitter_fix() | +-----------+-------------------------------+ -Controls how much physic ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows to smooth out framerate jitters. The default value of 0.5 should be fine for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. +Controls how much physics ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows to smooth out framerate jitters. The default value of 0.5 should be fine for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. ---- diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 71cf624aa..40258a4c3 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -36,175 +36,151 @@ Tutorials Properties ---------- -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`adjustment_brightness` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Texture` | :ref:`adjustment_color_correction` | | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`adjustment_contrast` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`adjustment_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`adjustment_saturation` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Color` | :ref:`ambient_light_color` | ``Color( 0, 0, 0, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ambient_light_energy` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ambient_light_sky_contribution` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`auto_exposure_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_max_luma` | ``8.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_min_luma` | ``0.05`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_scale` | ``0.4`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_speed` | ``0.5`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`int` | :ref:`background_camera_feed_id` | ``1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`int` | :ref:`background_canvas_max_layer` | ``0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Color` | :ref:`background_color` | ``Color( 0, 0, 0, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`background_energy` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`BGMode` | :ref:`background_mode` | ``0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Sky` | :ref:`background_sky` | | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`background_sky_custom_fov` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Basis` | :ref:`background_sky_orientation` | ``Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation` | ``Vector3( 0, 0, 0 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | ``Vector3( 0, 0, 0 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_amount` | ``0.1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_distance` | ``10.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_far_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | ``1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_transition` | ``5.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_amount` | ``0.1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_distance` | ``2.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_near_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | ``1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_transition` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Color` | :ref:`fog_color` | ``Color( 0.5, 0.6, 0.7, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_depth_begin` | ``10.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_depth_curve` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`fog_depth_enabled` | ``true`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_depth_end` | ``100.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`fog_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_height_curve` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`fog_height_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_height_max` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_height_min` | ``10.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_sun_amount` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Color` | :ref:`fog_sun_color` | ``Color( 1, 0.9, 0.7, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`fog_transmit_curve` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`fog_transmit_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_bicubic_upscale` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | ``2`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_bloom` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_luminance_cap` | ``12.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_scale` | ``2.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_threshold` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_intensity` | ``0.8`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/1` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/2` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/3` | ``true`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/4` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/5` | ``true`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/6` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/7` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`glow_strength` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | ``0.2`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_in` | ``0.15`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_out` | ``2.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`int` | :ref:`ss_reflections_max_steps` | ``64`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_roughness` | ``true`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_ao_channel_affect` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_bias` | ``0.01`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`SSAOBlur` | :ref:`ssao_blur` | ``3`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`Color` | :ref:`ssao_color` | ``Color( 0, 0, 0, 1 )`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_edge_sharpness` | ``4.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`bool` | :ref:`ssao_enabled` | ``false`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity2` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_light_affect` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`SSAOQuality` | :ref:`ssao_quality` | ``1`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_radius` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`ssao_radius2` | ``0.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`tonemap_exposure` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`ToneMapper` | :ref:`tonemap_mode` | ``0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ -| :ref:`float` | :ref:`tonemap_white` | ``1.0`` | -+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------+ ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`adjustment_brightness` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Texture2D` | :ref:`adjustment_color_correction` | | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`adjustment_contrast` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`adjustment_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`adjustment_saturation` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`ambient_light_color` | ``Color( 0, 0, 0, 1 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ambient_light_energy` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`ambient_light_occlusion_color` | ``Color( 0, 0, 0, 1 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ambient_light_sky_contribution` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`AmbientSource` | :ref:`ambient_light_source` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`auto_exposure_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`auto_exposure_max_luma` | ``8.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`auto_exposure_min_luma` | ``0.05`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`auto_exposure_scale` | ``0.4`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`auto_exposure_speed` | ``0.5`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`int` | :ref:`background_camera_feed_id` | ``1`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`int` | :ref:`background_canvas_max_layer` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`background_color` | ``Color( 0, 0, 0, 1 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`background_energy` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`BGMode` | :ref:`background_mode` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`fog_color` | ``Color( 0.5, 0.6, 0.7, 1 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_depth_begin` | ``10.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_depth_curve` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`fog_depth_enabled` | ``true`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_depth_end` | ``100.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`fog_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_height_curve` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`fog_height_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_height_max` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_height_min` | ``10.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_sun_amount` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Color` | :ref:`fog_sun_color` | ``Color( 1, 0.9, 0.7, 1 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`fog_transmit_curve` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`fog_transmit_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_bicubic_upscale` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | ``2`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_bloom` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_hdr_luminance_cap` | ``12.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_hdr_scale` | ``2.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_hdr_threshold` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_intensity` | ``0.8`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/1` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/2` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/3` | ``true`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/4` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/5` | ``true`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/6` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`glow_levels/7` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_mix` | ``0.05`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`glow_strength` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`ReflectionSource` | :ref:`reflected_light_source` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Sky` | :ref:`sky` | | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`sky_custom_fov` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`Vector3` | :ref:`sky_rotation` | ``Vector3( 0, 0, 0 )`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | ``0.2`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_in` | ``0.15`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_out` | ``2.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`int` | :ref:`ss_reflections_max_steps` | ``64`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_roughness` | ``true`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_ao_channel_affect` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_bias` | ``0.01`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`SSAOBlur` | :ref:`ssao_blur` | ``3`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_edge_sharpness` | ``4.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`bool` | :ref:`ssao_enabled` | ``false`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_intensity` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_light_affect` | ``0.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`ssao_radius` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`tonemap_exposure` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`ToneMapper` | :ref:`tonemap_mode` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ +| :ref:`float` | :ref:`tonemap_white` | ``1.0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-------------------------------+ Methods ------- @@ -220,39 +196,75 @@ Enumerations .. _enum_Environment_BGMode: -.. _class_Environment_constant_BG_KEEP: - .. _class_Environment_constant_BG_CLEAR_COLOR: .. _class_Environment_constant_BG_COLOR: .. _class_Environment_constant_BG_SKY: -.. _class_Environment_constant_BG_COLOR_SKY: - .. _class_Environment_constant_BG_CANVAS: +.. _class_Environment_constant_BG_KEEP: + .. _class_Environment_constant_BG_CAMERA_FEED: .. _class_Environment_constant_BG_MAX: enum **BGMode**: -- **BG_KEEP** = **5** --- Keeps on screen every pixel drawn in the background. This is the fastest background mode, but it can only be safely used in fully-interior scenes (no visible sky or sky reflections). If enabled in a scene where the background is visible, "ghost trail" artifacts will be visible when moving the camera. - - **BG_CLEAR_COLOR** = **0** --- Clears the background using the clear color defined in :ref:`ProjectSettings.rendering/environment/default_clear_color`. - **BG_COLOR** = **1** --- Clears the background using a custom clear color. - **BG_SKY** = **2** --- Displays a user-defined sky in the background. -- **BG_COLOR_SKY** = **3** --- Clears the background using a custom clear color and allows defining a sky for shading and reflection. This mode is slightly faster than :ref:`BG_SKY` and should be preferred in scenes where reflections can be visible, but the sky itself never is (e.g. top-down camera). +- **BG_CANVAS** = **3** --- Displays a :ref:`CanvasLayer` in the background. -- **BG_CANVAS** = **4** --- Displays a :ref:`CanvasLayer` in the background. +- **BG_KEEP** = **4** --- Keeps on screen every pixel drawn in the background. This is the fastest background mode, but it can only be safely used in fully-interior scenes (no visible sky or sky reflections). If enabled in a scene where the background is visible, "ghost trail" artifacts will be visible when moving the camera. -- **BG_CAMERA_FEED** = **6** --- Displays a camera feed in the background. +- **BG_CAMERA_FEED** = **5** --- Displays a camera feed in the background. -- **BG_MAX** = **7** --- Represents the size of the :ref:`BGMode` enum. +- **BG_MAX** = **6** --- Represents the size of the :ref:`BGMode` enum. + +---- + +.. _enum_Environment_AmbientSource: + +.. _class_Environment_constant_AMBIENT_SOURCE_BG: + +.. _class_Environment_constant_AMBIENT_SOURCE_DISABLED: + +.. _class_Environment_constant_AMBIENT_SOURCE_COLOR: + +.. _class_Environment_constant_AMBIENT_SOURCE_SKY: + +enum **AmbientSource**: + +- **AMBIENT_SOURCE_BG** = **0** + +- **AMBIENT_SOURCE_DISABLED** = **1** + +- **AMBIENT_SOURCE_COLOR** = **2** + +- **AMBIENT_SOURCE_SKY** = **3** + +---- + +.. _enum_Environment_ReflectionSource: + +.. _class_Environment_constant_REFLECTION_SOURCE_BG: + +.. _class_Environment_constant_REFLECTION_SOURCE_DISABLED: + +.. _class_Environment_constant_REFLECTION_SOURCE_SKY: + +enum **ReflectionSource**: + +- **REFLECTION_SOURCE_BG** = **0** + +- **REFLECTION_SOURCE_DISABLED** = **1** + +- **REFLECTION_SOURCE_SKY** = **2** ---- @@ -266,6 +278,8 @@ enum **BGMode**: .. _class_Environment_constant_GLOW_BLEND_MODE_REPLACE: +.. _class_Environment_constant_GLOW_BLEND_MODE_MIX: + enum **GlowBlendMode**: - **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. @@ -276,6 +290,8 @@ enum **GlowBlendMode**: - **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness. +- **GLOW_BLEND_MODE_MIX** = **4** + ---- .. _enum_Environment_ToneMapper: @@ -300,24 +316,6 @@ enum **ToneMapper**: ---- -.. _enum_Environment_DOFBlurQuality: - -.. _class_Environment_constant_DOF_BLUR_QUALITY_LOW: - -.. _class_Environment_constant_DOF_BLUR_QUALITY_MEDIUM: - -.. _class_Environment_constant_DOF_BLUR_QUALITY_HIGH: - -enum **DOFBlurQuality**: - -- **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality (fastest). - -- **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. - -- **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality (slowest). - ----- - .. _enum_Environment_SSAOBlur: .. _class_Environment_constant_SSAO_BLUR_DISABLED: @@ -338,24 +336,6 @@ enum **SSAOBlur**: - **SSAO_BLUR_3x3** = **3** --- 3×3 blur for the screen-space ambient occlusion effect (slowest). ----- - -.. _enum_Environment_SSAOQuality: - -.. _class_Environment_constant_SSAO_QUALITY_LOW: - -.. _class_Environment_constant_SSAO_QUALITY_MEDIUM: - -.. _class_Environment_constant_SSAO_QUALITY_HIGH: - -enum **SSAOQuality**: - -- **SSAO_QUALITY_LOW** = **0** --- Low quality for the screen-space ambient occlusion effect (fastest). - -- **SSAO_QUALITY_MEDIUM** = **1** --- Low quality for the screen-space ambient occlusion effect. - -- **SSAO_QUALITY_HIGH** = **2** --- Low quality for the screen-space ambient occlusion effect (slowest). - Property Descriptions --------------------- @@ -377,7 +357,7 @@ The global brightness value of the rendered scene. Effective only if ``adjustmen .. _class_Environment_property_adjustment_color_correction: -- :ref:`Texture` **adjustment_color_correction** +- :ref:`Texture2D` **adjustment_color_correction** +----------+----------------------------------------+ | *Setter* | set_adjustment_color_correction(value) | @@ -385,7 +365,7 @@ The global brightness value of the rendered scene. Effective only if ``adjustmen | *Getter* | get_adjustment_color_correction() | +----------+----------------------------------------+ -Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. Effective only if ``adjustment_enabled`` is ``true``. +Applies the provided :ref:`Texture2D` resource to affect the global color aspect of the rendered scene. Effective only if ``adjustment_enabled`` is ``true``. ---- @@ -469,6 +449,20 @@ The ambient light's energy. The higher the value, the stronger the light. ---- +.. _class_Environment_property_ambient_light_occlusion_color: + +- :ref:`Color` **ambient_light_occlusion_color** + ++-----------+-------------------------+ +| *Default* | ``Color( 0, 0, 0, 1 )`` | ++-----------+-------------------------+ +| *Setter* | set_ao_color(value) | ++-----------+-------------------------+ +| *Getter* | get_ao_color() | ++-----------+-------------------------+ + +---- + .. _class_Environment_property_ambient_light_sky_contribution: - :ref:`float` **ambient_light_sky_contribution** @@ -485,6 +479,20 @@ Defines the amount of light that the sky brings on the scene. A value of 0 means ---- +.. _class_Environment_property_ambient_light_source: + +- :ref:`AmbientSource` **ambient_light_source** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_ambient_source(value) | ++-----------+---------------------------+ +| *Getter* | get_ambient_source() | ++-----------+---------------------------+ + +---- + .. _class_Environment_property_auto_exposure_enabled: - :ref:`bool` **auto_exposure_enabled** @@ -609,7 +617,7 @@ The maximum layer ID to display. Only effective when using the :ref:`BG_CANVAS` displayed for clear areas of the scene. Only effective when using the :ref:`BG_COLOR` or :ref:`BG_COLOR_SKY` background modes). +The :ref:`Color` displayed for clear areas of the scene. Only effective when using the :ref:`BG_COLOR` background mode. ---- @@ -645,244 +653,6 @@ The background mode. See :ref:`BGMode` for possible val ---- -.. _class_Environment_property_background_sky: - -- :ref:`Sky` **background_sky** - -+----------+----------------+ -| *Setter* | set_sky(value) | -+----------+----------------+ -| *Getter* | get_sky() | -+----------+----------------+ - -The :ref:`Sky` resource defined as background. - ----- - -.. _class_Environment_property_background_sky_custom_fov: - -- :ref:`float` **background_sky_custom_fov** - -+-----------+---------------------------+ -| *Default* | ``0.0`` | -+-----------+---------------------------+ -| *Setter* | set_sky_custom_fov(value) | -+-----------+---------------------------+ -| *Getter* | get_sky_custom_fov() | -+-----------+---------------------------+ - -The :ref:`Sky` resource's custom field of view. - ----- - -.. _class_Environment_property_background_sky_orientation: - -- :ref:`Basis` **background_sky_orientation** - -+-----------+----------------------------------------+ -| *Default* | ``Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )`` | -+-----------+----------------------------------------+ -| *Setter* | set_sky_orientation(value) | -+-----------+----------------------------------------+ -| *Getter* | get_sky_orientation() | -+-----------+----------------------------------------+ - -The :ref:`Sky` resource's rotation expressed as a :ref:`Basis`. - ----- - -.. _class_Environment_property_background_sky_rotation: - -- :ref:`Vector3` **background_sky_rotation** - -+-----------+-------------------------+ -| *Default* | ``Vector3( 0, 0, 0 )`` | -+-----------+-------------------------+ -| *Setter* | set_sky_rotation(value) | -+-----------+-------------------------+ -| *Getter* | get_sky_rotation() | -+-----------+-------------------------+ - -The :ref:`Sky` resource's rotation expressed as Euler angles in radians. - ----- - -.. _class_Environment_property_background_sky_rotation_degrees: - -- :ref:`Vector3` **background_sky_rotation_degrees** - -+-----------+---------------------------------+ -| *Default* | ``Vector3( 0, 0, 0 )`` | -+-----------+---------------------------------+ -| *Setter* | set_sky_rotation_degrees(value) | -+-----------+---------------------------------+ -| *Getter* | get_sky_rotation_degrees() | -+-----------+---------------------------------+ - -The :ref:`Sky` resource's rotation expressed as Euler angles in degrees. - ----- - -.. _class_Environment_property_dof_blur_far_amount: - -- :ref:`float` **dof_blur_far_amount** - -+-----------+--------------------------------+ -| *Default* | ``0.1`` | -+-----------+--------------------------------+ -| *Setter* | set_dof_blur_far_amount(value) | -+-----------+--------------------------------+ -| *Getter* | get_dof_blur_far_amount() | -+-----------+--------------------------------+ - -The amount of far blur for the depth-of-field effect. - ----- - -.. _class_Environment_property_dof_blur_far_distance: - -- :ref:`float` **dof_blur_far_distance** - -+-----------+----------------------------------+ -| *Default* | ``10.0`` | -+-----------+----------------------------------+ -| *Setter* | set_dof_blur_far_distance(value) | -+-----------+----------------------------------+ -| *Getter* | get_dof_blur_far_distance() | -+-----------+----------------------------------+ - -The distance from the camera where the far blur effect affects the rendering. - ----- - -.. _class_Environment_property_dof_blur_far_enabled: - -- :ref:`bool` **dof_blur_far_enabled** - -+-----------+---------------------------------+ -| *Default* | ``false`` | -+-----------+---------------------------------+ -| *Setter* | set_dof_blur_far_enabled(value) | -+-----------+---------------------------------+ -| *Getter* | is_dof_blur_far_enabled() | -+-----------+---------------------------------+ - -If ``true``, enables the depth-of-field far blur effect. - ----- - -.. _class_Environment_property_dof_blur_far_quality: - -- :ref:`DOFBlurQuality` **dof_blur_far_quality** - -+-----------+---------------------------------+ -| *Default* | ``1`` | -+-----------+---------------------------------+ -| *Setter* | set_dof_blur_far_quality(value) | -+-----------+---------------------------------+ -| *Getter* | get_dof_blur_far_quality() | -+-----------+---------------------------------+ - -The depth-of-field far blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower. - ----- - -.. _class_Environment_property_dof_blur_far_transition: - -- :ref:`float` **dof_blur_far_transition** - -+-----------+------------------------------------+ -| *Default* | ``5.0`` | -+-----------+------------------------------------+ -| *Setter* | set_dof_blur_far_transition(value) | -+-----------+------------------------------------+ -| *Getter* | get_dof_blur_far_transition() | -+-----------+------------------------------------+ - -The length of the transition between the no-blur area and far blur. - ----- - -.. _class_Environment_property_dof_blur_near_amount: - -- :ref:`float` **dof_blur_near_amount** - -+-----------+---------------------------------+ -| *Default* | ``0.1`` | -+-----------+---------------------------------+ -| *Setter* | set_dof_blur_near_amount(value) | -+-----------+---------------------------------+ -| *Getter* | get_dof_blur_near_amount() | -+-----------+---------------------------------+ - -The amount of near blur for the depth-of-field effect. - ----- - -.. _class_Environment_property_dof_blur_near_distance: - -- :ref:`float` **dof_blur_near_distance** - -+-----------+-----------------------------------+ -| *Default* | ``2.0`` | -+-----------+-----------------------------------+ -| *Setter* | set_dof_blur_near_distance(value) | -+-----------+-----------------------------------+ -| *Getter* | get_dof_blur_near_distance() | -+-----------+-----------------------------------+ - -Distance from the camera where the near blur effect affects the rendering. - ----- - -.. _class_Environment_property_dof_blur_near_enabled: - -- :ref:`bool` **dof_blur_near_enabled** - -+-----------+----------------------------------+ -| *Default* | ``false`` | -+-----------+----------------------------------+ -| *Setter* | set_dof_blur_near_enabled(value) | -+-----------+----------------------------------+ -| *Getter* | is_dof_blur_near_enabled() | -+-----------+----------------------------------+ - -If ``true``, enables the depth-of-field near blur effect. - ----- - -.. _class_Environment_property_dof_blur_near_quality: - -- :ref:`DOFBlurQuality` **dof_blur_near_quality** - -+-----------+----------------------------------+ -| *Default* | ``1`` | -+-----------+----------------------------------+ -| *Setter* | set_dof_blur_near_quality(value) | -+-----------+----------------------------------+ -| *Getter* | get_dof_blur_near_quality() | -+-----------+----------------------------------+ - -The depth-of-field near blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower. - ----- - -.. _class_Environment_property_dof_blur_near_transition: - -- :ref:`float` **dof_blur_near_transition** - -+-----------+-------------------------------------+ -| *Default* | ``1.0`` | -+-----------+-------------------------------------+ -| *Setter* | set_dof_blur_near_transition(value) | -+-----------+-------------------------------------+ -| *Getter* | get_dof_blur_near_transition() | -+-----------+-------------------------------------+ - -The length of the transition between the near blur and no-blur area. - ----- - .. _class_Environment_property_fog_color: - :ref:`Color` **fog_color** @@ -1349,6 +1119,20 @@ If ``true``, the 7th level of glow is enabled. This is the most "global" level ( ---- +.. _class_Environment_property_glow_mix: + +- :ref:`float` **glow_mix** + ++-----------+---------------------+ +| *Default* | ``0.05`` | ++-----------+---------------------+ +| *Setter* | set_glow_mix(value) | ++-----------+---------------------+ +| *Getter* | get_glow_mix() | ++-----------+---------------------+ + +---- + .. _class_Environment_property_glow_strength: - :ref:`float` **glow_strength** @@ -1365,6 +1149,62 @@ The glow strength. When using the GLES2 renderer, this should be increased to 1. ---- +.. _class_Environment_property_reflected_light_source: + +- :ref:`ReflectionSource` **reflected_light_source** + ++-----------+------------------------------+ +| *Default* | ``0`` | ++-----------+------------------------------+ +| *Setter* | set_reflection_source(value) | ++-----------+------------------------------+ +| *Getter* | get_reflection_source() | ++-----------+------------------------------+ + +---- + +.. _class_Environment_property_sky: + +- :ref:`Sky` **sky** + ++----------+----------------+ +| *Setter* | set_sky(value) | ++----------+----------------+ +| *Getter* | get_sky() | ++----------+----------------+ + +The :ref:`Sky` resource used for this ``Environment``. + +---- + +.. _class_Environment_property_sky_custom_fov: + +- :ref:`float` **sky_custom_fov** + ++-----------+---------------------------+ +| *Default* | ``0.0`` | ++-----------+---------------------------+ +| *Setter* | set_sky_custom_fov(value) | ++-----------+---------------------------+ +| *Getter* | get_sky_custom_fov() | ++-----------+---------------------------+ + +---- + +.. _class_Environment_property_sky_rotation: + +- :ref:`Vector3` **sky_rotation** + ++-----------+-------------------------+ +| *Default* | ``Vector3( 0, 0, 0 )`` | ++-----------+-------------------------+ +| *Setter* | set_sky_rotation(value) | ++-----------+-------------------------+ +| *Getter* | get_sky_rotation() | ++-----------+-------------------------+ + +---- + .. _class_Environment_property_ss_reflections_depth_tolerance: - :ref:`float` **ss_reflections_depth_tolerance** @@ -1509,22 +1349,6 @@ The screen-space ambient occlusion blur quality. See :ref:`SSAOBlur` **ssao_color** - -+-----------+-------------------------+ -| *Default* | ``Color( 0, 0, 0, 1 )`` | -+-----------+-------------------------+ -| *Setter* | set_ssao_color(value) | -+-----------+-------------------------+ -| *Getter* | get_ssao_color() | -+-----------+-------------------------+ - -The screen-space ambient occlusion color. - ----- - .. _class_Environment_property_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** @@ -1573,22 +1397,6 @@ The primary screen-space ambient occlusion intensity. See also :ref:`ssao_radius ---- -.. _class_Environment_property_ssao_intensity2: - -- :ref:`float` **ssao_intensity2** - -+-----------+----------------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------------+ -| *Setter* | set_ssao_intensity2(value) | -+-----------+----------------------------+ -| *Getter* | get_ssao_intensity2() | -+-----------+----------------------------+ - -The secondary screen-space ambient occlusion intensity. See also :ref:`ssao_radius2`. - ----- - .. _class_Environment_property_ssao_light_affect: - :ref:`float` **ssao_light_affect** @@ -1605,22 +1413,6 @@ The screen-space ambient occlusion intensity in direct light. In real life, ambi ---- -.. _class_Environment_property_ssao_quality: - -- :ref:`SSAOQuality` **ssao_quality** - -+-----------+-------------------------+ -| *Default* | ``1`` | -+-----------+-------------------------+ -| *Setter* | set_ssao_quality(value) | -+-----------+-------------------------+ -| *Getter* | get_ssao_quality() | -+-----------+-------------------------+ - -The screen-space ambient occlusion quality. Higher qualities will make better use of small objects for ambient occlusion, but are slower. - ----- - .. _class_Environment_property_ssao_radius: - :ref:`float` **ssao_radius** @@ -1637,22 +1429,6 @@ The primary screen-space ambient occlusion radius. ---- -.. _class_Environment_property_ssao_radius2: - -- :ref:`float` **ssao_radius2** - -+-----------+-------------------------+ -| *Default* | ``0.0`` | -+-----------+-------------------------+ -| *Setter* | set_ssao_radius2(value) | -+-----------+-------------------------+ -| *Getter* | get_ssao_radius2() | -+-----------+-------------------------+ - -The secondary screen-space ambient occlusion radius. If set to a value higher than ``0``, enables the secondary screen-space ambient occlusion effect which can be used to improve the effect's appearance (at the cost of performance). - ----- - .. _class_Environment_property_tonemap_exposure: - :ref:`float` **tonemap_exposure** diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 73dee6b93..6d3fd0703 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -48,7 +48,7 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_execute_failed` **(** **)** const | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | +| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PackedStringArray` input_names=PackedStringArray( ) **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions @@ -82,7 +82,7 @@ Returns ``true`` if :ref:`execute` has failed. .. _class_Expression_method_parse: -- :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** +- :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PackedStringArray` input_names=PackedStringArray( ) **)** Parses the expression and returns an :ref:`Error` code. diff --git a/classes/class_file.rst b/classes/class_file.rst index 74e698fed..4a3ade99e 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -50,95 +50,95 @@ Properties Methods ------- -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_error` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pascal_string` **(** **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`ModeFlags` flags **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_16` **(** :ref:`int` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_32` **(** :ref:`int` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_64` **(** :ref:`int` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_8` **(** :ref:`int` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_csv_line` **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_double` **(** :ref:`float` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_float` **(** :ref:`float` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_real` **(** :ref:`float` value **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`eof_reached` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_error` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_len` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pascal_string` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_real` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_open` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`ModeFlags` flags **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PackedByteArray` key **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_16` **(** :ref:`int` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_32` **(** :ref:`int` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_64` **(** :ref:`int` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_8` **(** :ref:`int` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_buffer` **(** :ref:`PackedByteArray` buffer **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_csv_line` **(** :ref:`PackedStringArray` values, :ref:`String` delim="," **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_double` **(** :ref:`float` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_float` **(** :ref:`float` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_line` **(** :ref:`String` line **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_real` **(** :ref:`float` value **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_string` **(** :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -279,15 +279,15 @@ Text is interpreted as being UTF-8 encoded. .. _class_File_method_get_buffer: -- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const +- :ref:`PackedByteArray` **get_buffer** **(** :ref:`int` len **)** const -Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. +Returns next ``len`` bytes of the file as a :ref:`PackedByteArray`. ---- .. _class_File_method_get_csv_line: -- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const +- :ref:`PackedStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. @@ -439,7 +439,7 @@ Opens a compressed file for reading or writing. .. _class_File_method_open_encrypted: -- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PoolByteArray` key **)** +- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PackedByteArray` key **)** Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -505,7 +505,7 @@ Stores an integer as 8 bits in the file. .. _class_File_method_store_buffer: -- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** +- void **store_buffer** **(** :ref:`PackedByteArray` buffer **)** Stores the given array of bytes in the file. @@ -513,9 +513,9 @@ Stores the given array of bytes in the file. .. _class_File_method_store_csv_line: -- void **store_csv_line** **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** +- void **store_csv_line** **(** :ref:`PackedStringArray` values, :ref:`String` delim="," **)** -Store the given :ref:`PoolStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. +Store the given :ref:`PackedStringArray` in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter ``delim`` to use other than the default ``","`` (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index fcd183170..6f95a54bc 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -21,27 +21,27 @@ FileDialog is a preset dialog used to choose files and directories in the filesy Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`Access` | :ref:`access` | ``0`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`String` | :ref:`current_dir` | ``"res://"`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`String` | :ref:`current_file` | ``""`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`String` | :ref:`current_path` | ``"res://"`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | dialog_hide_on_ok | **O:** ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`PoolStringArray` | :ref:`filters` | ``PoolStringArray( )`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`Mode` | :ref:`mode` | ``4`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`show_hidden_files` | ``false`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ -| :ref:`String` | window_title | **O:** ``"Save a File"`` | -+-----------------------------------------------+-----------------------------------------------------------------------------+--------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`Access` | :ref:`access` | ``0`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`String` | :ref:`current_dir` | ``"res://"`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`String` | :ref:`current_file` | ``""`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`String` | :ref:`current_path` | ``"res://"`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | dialog_hide_on_ok | **O:** ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`PackedStringArray` | :ref:`filters` | ``PackedStringArray( )`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`Mode` | :ref:`mode` | ``4`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`mode_overrides_title` | ``true`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`bool` | :ref:`show_hidden_files` | ``false`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ +| :ref:`String` | window_title | **O:** ``"Save a File"`` | ++---------------------------------------------------+-----------------------------------------------------------------------------+---------------------------+ Methods ------- @@ -63,19 +63,19 @@ Methods Theme Properties ---------------- -+-------------------------------+----------------------+-----------------------+ -| :ref:`Color` | files_disabled | Color( 0, 0, 0, 0.7 ) | -+-------------------------------+----------------------+-----------------------+ -| :ref:`Texture` | folder | | -+-------------------------------+----------------------+-----------------------+ -| :ref:`Color` | folder_icon_modulate | Color( 1, 1, 1, 1 ) | -+-------------------------------+----------------------+-----------------------+ -| :ref:`Texture` | parent_folder | | -+-------------------------------+----------------------+-----------------------+ -| :ref:`Texture` | reload | | -+-------------------------------+----------------------+-----------------------+ -| :ref:`Texture` | toggle_hidden | | -+-------------------------------+----------------------+-----------------------+ ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Color` | files_disabled | Color( 0, 0, 0, 0.7 ) | ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Texture2D` | folder | | ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Color` | folder_icon_modulate | Color( 1, 1, 1, 1 ) | ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Texture2D` | parent_folder | | ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Texture2D` | reload | | ++-----------------------------------+----------------------+-----------------------+ +| :ref:`Texture2D` | toggle_hidden | | ++-----------------------------------+----------------------+-----------------------+ Signals ------- @@ -98,7 +98,7 @@ Emitted when the user selects a file by double-clicking it or pressing the **OK* .. _class_FileDialog_signal_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PackedStringArray` paths **)** Emitted when the user selects multiple files. @@ -216,17 +216,17 @@ The currently selected file path of the file dialog. .. _class_FileDialog_property_filters: -- :ref:`PoolStringArray` **filters** +- :ref:`PackedStringArray` **filters** -+-----------+-------------------------+ -| *Default* | ``PoolStringArray( )`` | -+-----------+-------------------------+ -| *Setter* | set_filters(value) | -+-----------+-------------------------+ -| *Getter* | get_filters() | -+-----------+-------------------------+ ++-----------+---------------------------+ +| *Default* | ``PackedStringArray( )`` | ++-----------+---------------------------+ +| *Setter* | set_filters(value) | ++-----------+---------------------------+ +| *Getter* | get_filters() | ++-----------+---------------------------+ -The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. +The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. ---- diff --git a/classes/class_font.rst b/classes/class_font.rst index e1e9c80ce..32ec39ec9 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -100,6 +100,8 @@ Returns the size of a string, taking kerning and advance into account. - :ref:`Vector2` **get_wordwrap_string_size** **(** :ref:`String` string, :ref:`float` width **)** const +Returns the size that the string would have with word wrapping enabled with a fixed ``width``. + ---- .. _class_Font_method_has_outline: diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 1d6ce48cc..441f70ce5 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -23,17 +23,17 @@ However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` | :ref:`call_func` **(** ... **)** vararg | -+-------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_funcv` **(** :ref:`Array` arg_array **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` name **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_func` **(** ... **)** vararg | ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_funcv` **(** :ref:`Array` arg_array **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function` **(** :ref:`StringName` name **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -64,7 +64,7 @@ Returns whether the object still exists and has the function assigned. .. _class_FuncRef_method_set_function: -- void **set_function** **(** :ref:`String` name **)** +- void **set_function** **(** :ref:`StringName` name **)** The name of the referenced function to call on the object, without parentheses or any parameters. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 70daac3d1..091610fb9 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -23,13 +23,13 @@ Properties Methods ------- -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`initialize` **(** **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`terminate` **(** **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_native` **(** :ref:`StringName` calling_type, :ref:`StringName` procedure_name, :ref:`Array` arguments **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`initialize` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`terminate` **(** **)** | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -49,7 +49,7 @@ Method Descriptions .. _class_GDNative_method_call_native: -- :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** +- :ref:`Variant` **call_native** **(** :ref:`StringName` calling_type, :ref:`StringName` procedure_name, :ref:`Array` arguments **)** ---- diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index a17000e75..40d55ce8c 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -43,11 +43,11 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_current_dependencies` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -141,7 +141,7 @@ Method Descriptions .. _class_GDNativeLibrary_method_get_current_dependencies: -- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const +- :ref:`PackedStringArray` **get_current_dependencies** **(** **)** const Returns paths to all dependency libraries for the current platform and architecture. diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 5be67f800..9a1d2b741 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -28,18 +28,18 @@ Tutorials Methods ------- -+-------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | -+-------------------------------------------+-----------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | -+-------------------------------------------+-----------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_as_byte_code` **(** **)** const | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | ++-----------------------------------------------+-----------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_GDScript_method_get_as_byte_code: -- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const +- :ref:`PackedByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 19112b8d8..0ef1302b3 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -21,77 +21,77 @@ Geometry provides users with a set of helper functions to create geometric shape Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`clip_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`clip_polyline_with_polygon_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`exclude_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_polyline_with_polygon_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_in_circle` **(** :ref:`Vector2` point, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_in_polygon` **(** :ref:`Vector2` point, :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_polygon_clockwise` **(** :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`merge_polygons_2d` **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`offset_polygon_2d` **(** :ref:`PoolVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`offset_polyline_2d` **(** :ref:`PoolVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_delaunay_2d` **(** :ref:`PoolVector2Array` points **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, Vector3.Axis axis=2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, Vector3.Axis axis=2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`clip_polygon` **(** :ref:`PackedVector3Array` points, :ref:`Plane` plane **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`clip_polygons_2d` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`clip_polyline_with_polygon_2d` **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PackedVector2Array` points **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`exclude_polygons_2d` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_polygons_2d` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_polyline_with_polygon_2d` **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_in_circle` **(** :ref:`Vector2` point, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_in_polygon` **(** :ref:`Vector2` point, :ref:`PackedVector2Array` polygon **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_polygon_clockwise` **(** :ref:`PackedVector2Array` polygon **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PackedVector2Array` sizes **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`merge_polygons_2d` **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`offset_polygon_2d` **(** :ref:`PackedVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`offset_polyline_2d` **(** :ref:`PackedVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`triangulate_delaunay_2d` **(** :ref:`PackedVector2Array` points **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`triangulate_polygon` **(** :ref:`PackedVector2Array` polygon **)** | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -189,7 +189,7 @@ Returns an array of :ref:`Plane`\ s closely bounding a faceted cyli .. _class_Geometry_method_clip_polygon: -- :ref:`PoolVector3Array` **clip_polygon** **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** +- :ref:`PackedVector3Array` **clip_polygon** **(** :ref:`PackedVector3Array` points, :ref:`Plane` plane **)** Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. @@ -197,17 +197,17 @@ Clips the polygon defined by the points in ``points`` against the ``plane`` and .. _class_Geometry_method_clip_polygons_2d: -- :ref:`Array` **clip_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** +- :ref:`Array` **clip_polygons_2d** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** Clips ``polygon_a`` against ``polygon_b`` and returns an array of clipped polygons. This performs :ref:`OPERATION_DIFFERENCE` between polygons. Returns an empty array if ``polygon_b`` completely overlaps ``polygon_a``. -If ``polygon_b`` is enclosed by ``polygon_a``, returns an outer polygon (boundary) and inner polygon (hole) which could be distiguished by calling :ref:`is_polygon_clockwise`. +If ``polygon_b`` is enclosed by ``polygon_a``, returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling :ref:`is_polygon_clockwise`. ---- .. _class_Geometry_method_clip_polyline_with_polygon_2d: -- :ref:`Array` **clip_polyline_with_polygon_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** +- :ref:`Array` **clip_polyline_with_polygon_2d** **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines. This performs :ref:`OPERATION_DIFFERENCE` between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. @@ -215,7 +215,7 @@ Clips ``polyline`` against ``polygon`` and returns an array of clipped polylines .. _class_Geometry_method_convex_hull_2d: -- :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** +- :ref:`PackedVector2Array` **convex_hull_2d** **(** :ref:`PackedVector2Array` points **)** Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. @@ -223,11 +223,11 @@ Given an array of :ref:`Vector2`\ s, returns the convex hull as a .. _class_Geometry_method_exclude_polygons_2d: -- :ref:`Array` **exclude_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** +- :ref:`Array` **exclude_polygons_2d** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** Mutually excludes common area defined by intersection of ``polygon_a`` and ``polygon_b`` (see :ref:`intersect_polygons_2d`) and returns an array of excluded polygons. This performs :ref:`OPERATION_XOR` between polygons. In other words, returns all but common area between polygons. -The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling :ref:`is_polygon_clockwise`. +The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling :ref:`is_polygon_clockwise`. ---- @@ -265,17 +265,17 @@ Returns the 2D point on the 2D line defined by (``s1``, ``s2``) that is closest .. _class_Geometry_method_get_closest_points_between_segments: -- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** +- :ref:`PackedVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** -Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +Given the two 3D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). ---- .. _class_Geometry_method_get_closest_points_between_segments_2d: -- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** +- :ref:`PackedVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** -Given the two 2D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +Given the two 2D segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PackedVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). ---- @@ -289,7 +289,7 @@ Used internally by the engine. .. _class_Geometry_method_intersect_polygons_2d: -- :ref:`Array` **intersect_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** +- :ref:`Array` **intersect_polygons_2d** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** Intersects ``polygon_a`` with ``polygon_b`` and returns an array of intersected polygons. This performs :ref:`OPERATION_INTERSECTION` between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. @@ -299,7 +299,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. _class_Geometry_method_intersect_polyline_with_polygon_2d: -- :ref:`Array` **intersect_polyline_with_polygon_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`PoolVector2Array` polygon **)** +- :ref:`Array` **intersect_polyline_with_polygon_2d** **(** :ref:`PackedVector2Array` polyline, :ref:`PackedVector2Array` polygon **)** Intersects ``polyline`` with ``polygon`` and returns an array of intersected polylines. This performs :ref:`OPERATION_INTERSECTION` between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. @@ -315,7 +315,7 @@ Returns ``true`` if ``point`` is inside the circle or if it's located exactly *o .. _class_Geometry_method_is_point_in_polygon: -- :ref:`bool` **is_point_in_polygon** **(** :ref:`Vector2` point, :ref:`PoolVector2Array` polygon **)** +- :ref:`bool` **is_point_in_polygon** **(** :ref:`Vector2` point, :ref:`PackedVector2Array` polygon **)** Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly *on* polygon's boundary, otherwise returns ``false``. @@ -323,7 +323,7 @@ Returns ``true`` if ``point`` is inside ``polygon`` or if it's located exactly * .. _class_Geometry_method_is_polygon_clockwise: -- :ref:`bool` **is_polygon_clockwise** **(** :ref:`PoolVector2Array` polygon **)** +- :ref:`bool` **is_polygon_clockwise** **(** :ref:`PackedVector2Array` polygon **)** Returns ``true`` if ``polygon``'s vertices are ordered in clockwise order, otherwise returns ``false``. @@ -341,7 +341,7 @@ Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) inte .. _class_Geometry_method_make_atlas: -- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** +- :ref:`Dictionary` **make_atlas** **(** :ref:`PackedVector2Array` sizes **)** Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. @@ -349,7 +349,7 @@ Given an array of :ref:`Vector2`\ s representing tiles, builds an .. _class_Geometry_method_merge_polygons_2d: -- :ref:`Array` **merge_polygons_2d** **(** :ref:`PoolVector2Array` polygon_a, :ref:`PoolVector2Array` polygon_b **)** +- :ref:`Array` **merge_polygons_2d** **(** :ref:`PackedVector2Array` polygon_a, :ref:`PackedVector2Array` polygon_b **)** Merges (combines) ``polygon_a`` and ``polygon_b`` and returns an array of merged polygons. This performs :ref:`OPERATION_UNION` between polygons. @@ -359,7 +359,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. _class_Geometry_method_offset_polygon_2d: -- :ref:`Array` **offset_polygon_2d** **(** :ref:`PoolVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** +- :ref:`Array` **offset_polygon_2d** **(** :ref:`PackedVector2Array` polygon, :ref:`float` delta, :ref:`PolyJoinType` join_type=0 **)** Inflates or deflates ``polygon`` by ``delta`` units (pixels). If ``delta`` is positive, makes the polygon grow outward. If ``delta`` is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if ``delta`` is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. @@ -371,7 +371,7 @@ The operation may result in an outer polygon (boundary) and inner polygon (hole) .. _class_Geometry_method_offset_polyline_2d: -- :ref:`Array` **offset_polyline_2d** **(** :ref:`PoolVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** +- :ref:`Array` **offset_polyline_2d** **(** :ref:`PackedVector2Array` polyline, :ref:`float` delta, :ref:`PolyJoinType` join_type=0, :ref:`PolyEndType` end_type=3 **)** Inflates or deflates ``polyline`` by ``delta`` units (pixels), producing polygons. If ``delta`` is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If ``delta`` is negative, returns an empty array. @@ -409,17 +409,17 @@ Given the 2D segment (``segment_from``, ``segment_to``), returns the position on .. _class_Geometry_method_segment_intersects_convex: -- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** +- :ref:`PackedVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** -Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PoolVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. +Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PackedVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. ---- .. _class_Geometry_method_segment_intersects_cylinder: -- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** +- :ref:`PackedVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** -Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PoolVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. +Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PackedVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. ---- @@ -433,9 +433,9 @@ Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) int .. _class_Geometry_method_segment_intersects_sphere: -- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** +- :ref:`PackedVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** -Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PoolVector3Array`. If yes, returns a :ref:`PoolVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. +Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PackedVector3Array`. If yes, returns a :ref:`PackedVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. ---- @@ -449,15 +449,15 @@ Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, `` .. _class_Geometry_method_triangulate_delaunay_2d: -- :ref:`PoolIntArray` **triangulate_delaunay_2d** **(** :ref:`PoolVector2Array` points **)** +- :ref:`PackedInt32Array` **triangulate_delaunay_2d** **(** :ref:`PackedVector2Array` points **)** -Triangulates the area specified by discrete set of ``points`` such that no point is inside the circumcircle of any resulting triangle. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``points`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. +Triangulates the area specified by discrete set of ``points`` such that no point is inside the circumcircle of any resulting triangle. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``points`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. ---- .. _class_Geometry_method_triangulate_polygon: -- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- :ref:`PackedInt32Array` **triangulate_polygon** **(** :ref:`PackedVector2Array` polygon **)** -Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. +Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PackedInt32Array` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PackedInt32Array` is returned. diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index a289a9aba..b681e2462 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -38,6 +38,8 @@ Properties +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`Material` | :ref:`material_override` | | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`use_dynamic_gi` | ``false`` | ++-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`use_in_baked_light` | ``false`` | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ @@ -87,17 +89,21 @@ In other words, the actual mesh will not be visible, only the shadows casted fro .. _class_GeometryInstance_constant_FLAG_USE_BAKED_LIGHT: +.. _class_GeometryInstance_constant_FLAG_USE_DYNAMIC_GI: + .. _class_GeometryInstance_constant_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: .. _class_GeometryInstance_constant_FLAG_MAX: enum **Flags**: -- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` or :ref:`BakedLightmap`. +- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe`. -- **FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** --- Unused in this class, exposed for consistency with :ref:`InstanceFlags`. +- **FLAG_USE_DYNAMIC_GI** = **1** -- **FLAG_MAX** = **2** --- Represents the size of the :ref:`Flags` enum. +- **FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **2** --- Unused in this class, exposed for consistency with :ref:`InstanceFlags`. + +- **FLAG_MAX** = **3** --- Represents the size of the :ref:`Flags` enum. Property Descriptions --------------------- @@ -222,6 +228,20 @@ If a material is assigned to this property, it will be used instead of any mater ---- +.. _class_GeometryInstance_property_use_dynamic_gi: + +- :ref:`bool` **use_dynamic_gi** + ++-----------+-----------------+ +| *Default* | ``false`` | ++-----------+-----------------+ +| *Setter* | set_flag(value) | ++-----------+-----------------+ +| *Getter* | get_flag() | ++-----------+-----------------+ + +---- + .. _class_GeometryInstance_property_use_in_baked_light: - :ref:`bool` **use_in_baked_light** @@ -234,7 +254,7 @@ If a material is assigned to this property, it will be used instead of any mater | *Getter* | get_flag() | +-----------+-----------------+ -If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe` or :ref:`BakedLightmap`. +If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe`. Method Descriptions ------------------- diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 43c4f6209..6b43a3492 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -18,7 +18,7 @@ Description ``GIProbe``\ s are used to provide high-quality real-time indirect light to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. ``GIProbe``\ s need to be baked before using, however, once baked, dynamic objects will receive light from them. Further, lights can be fully dynamic or baked. -Having ``GIProbe``\ s in a scene can be expensive, the quality of the probe can be turned down in exchange for better performance in the :ref:`ProjectSettings` using :ref:`ProjectSettings.rendering/quality/voxel_cone_tracing/high_quality`. +Having ``GIProbe``\ s in a scene can be expensive, the quality of the probe can be turned down in exchange for better performance in the :ref:`ProjectSettings` using :ref:`ProjectSettings.rendering/quality/gi_probes/quality`. Tutorials --------- @@ -28,27 +28,13 @@ Tutorials Properties ---------- -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`bias` | ``1.5`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`compress` | ``false`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`GIProbeData` | :ref:`data` | | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`int` | :ref:`dynamic_range` | ``4`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`energy` | ``1.0`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`Vector3` | :ref:`extents` | ``Vector3( 10, 10, 10 )`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`bool` | :ref:`interior` | ``false`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`normal_bias` | ``0.0`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`float` | :ref:`propagation` | ``0.7`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ -| :ref:`Subdiv` | :ref:`subdiv` | ``1`` | -+---------------------------------------+------------------------------------------------------------+---------------------------+ ++---------------------------------------+------------------------------------------------+---------------------------+ +| :ref:`GIProbeData` | :ref:`data` | | ++---------------------------------------+------------------------------------------------+---------------------------+ +| :ref:`Vector3` | :ref:`extents` | ``Vector3( 10, 10, 10 )`` | ++---------------------------------------+------------------------------------------------+---------------------------+ +| :ref:`Subdiv` | :ref:`subdiv` | ``1`` | ++---------------------------------------+------------------------------------------------+---------------------------+ Methods ------- @@ -89,40 +75,6 @@ enum **Subdiv**: Property Descriptions --------------------- -.. _class_GIProbe_property_bias: - -- :ref:`float` **bias** - -+-----------+-----------------+ -| *Default* | ``1.5`` | -+-----------+-----------------+ -| *Setter* | set_bias(value) | -+-----------+-----------------+ -| *Getter* | get_bias() | -+-----------+-----------------+ - -Offsets the lookup of the light contribution from the ``GIProbe``. This can be used to avoid self-shadowing, but may introduce light leaking at higher values. This and :ref:`normal_bias` should be played around with to minimize self-shadowing and light leaking. - -**Note:** ``bias`` should usually be above 1.0 as that is the size of the voxels. - ----- - -.. _class_GIProbe_property_compress: - -- :ref:`bool` **compress** - -+-----------+---------------------+ -| *Default* | ``false`` | -+-----------+---------------------+ -| *Setter* | set_compress(value) | -+-----------+---------------------+ -| *Getter* | is_compressed() | -+-----------+---------------------+ - -If ``true``, the data for this ``GIProbe`` will be compressed. Compression saves space, but results in far worse visual quality. - ----- - .. _class_GIProbe_property_data: - :ref:`GIProbeData` **data** @@ -137,38 +89,6 @@ The :ref:`GIProbeData` resource that holds the data for this ---- -.. _class_GIProbe_property_dynamic_range: - -- :ref:`int` **dynamic_range** - -+-----------+--------------------------+ -| *Default* | ``4`` | -+-----------+--------------------------+ -| *Setter* | set_dynamic_range(value) | -+-----------+--------------------------+ -| *Getter* | get_dynamic_range() | -+-----------+--------------------------+ - -The maximum brightness that the ``GIProbe`` will recognize. Brightness will be scaled within this range. - ----- - -.. _class_GIProbe_property_energy: - -- :ref:`float` **energy** - -+-----------+-------------------+ -| *Default* | ``1.0`` | -+-----------+-------------------+ -| *Setter* | set_energy(value) | -+-----------+-------------------+ -| *Getter* | get_energy() | -+-----------+-------------------+ - -Energy multiplier. Makes the lighting contribution from the ``GIProbe`` brighter. - ----- - .. _class_GIProbe_property_extents: - :ref:`Vector3` **extents** @@ -185,54 +105,6 @@ The size of the area covered by the ``GIProbe``. If you make the extents larger ---- -.. _class_GIProbe_property_interior: - -- :ref:`bool` **interior** - -+-----------+---------------------+ -| *Default* | ``false`` | -+-----------+---------------------+ -| *Setter* | set_interior(value) | -+-----------+---------------------+ -| *Getter* | is_interior() | -+-----------+---------------------+ - -If ``true``, ignores the sky contribution when calculating lighting. - ----- - -.. _class_GIProbe_property_normal_bias: - -- :ref:`float` **normal_bias** - -+-----------+------------------------+ -| *Default* | ``0.0`` | -+-----------+------------------------+ -| *Setter* | set_normal_bias(value) | -+-----------+------------------------+ -| *Getter* | get_normal_bias() | -+-----------+------------------------+ - -Offsets the lookup into the ``GIProbe`` based on the object's normal direction. Can be used to reduce some self-shadowing artifacts. - ----- - -.. _class_GIProbe_property_propagation: - -- :ref:`float` **propagation** - -+-----------+------------------------+ -| *Default* | ``0.7`` | -+-----------+------------------------+ -| *Setter* | set_propagation(value) | -+-----------+------------------------+ -| *Getter* | get_propagation() | -+-----------+------------------------+ - -How much light propagates through the probe internally. A higher value allows light to spread further. - ----- - .. _class_GIProbe_property_subdiv: - :ref:`Subdiv` **subdiv** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 0948ef259..3495207ba 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -16,39 +16,98 @@ GIProbeData Properties ---------- -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`bias` | ``0.4`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`AABB` | :ref:`bounds` | ``AABB( 0, 0, 0, 1, 1, 1 )`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`cell_size` | ``1.0`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`compress` | ``false`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`dynamic_data` | ``PoolIntArray( )`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`dynamic_range` | ``1`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`energy` | ``1.0`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`interior` | ``false`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`normal_bias` | ``0.4`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`propagation` | ``1.0`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform` | :ref:`to_cell_xform` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | -+-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`anisotropy_strength` | ``0.5`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`ao` | ``0.0`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`ao_size` | ``0.5`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`bias` | ``1.5`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dynamic_range` | ``4.0`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`energy` | ``1.0`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`interior` | ``false`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`normal_bias` | ``0.0`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`propagation` | ``0.7`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`use_two_bounces` | ``false`` | ++---------------------------+----------------------------------------------------------------------------+-----------+ + +Methods +------- + ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`allocate` **(** :ref:`Transform` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_bounds` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_data_cells` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_level_counts` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_octree_cells` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_octree_size` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- +.. _class_GIProbeData_property_anisotropy_strength: + +- :ref:`float` **anisotropy_strength** + ++-----------+--------------------------------+ +| *Default* | ``0.5`` | ++-----------+--------------------------------+ +| *Setter* | set_anisotropy_strength(value) | ++-----------+--------------------------------+ +| *Getter* | get_anisotropy_strength() | ++-----------+--------------------------------+ + +---- + +.. _class_GIProbeData_property_ao: + +- :ref:`float` **ao** + ++-----------+---------------+ +| *Default* | ``0.0`` | ++-----------+---------------+ +| *Setter* | set_ao(value) | ++-----------+---------------+ +| *Getter* | get_ao() | ++-----------+---------------+ + +---- + +.. _class_GIProbeData_property_ao_size: + +- :ref:`float` **ao_size** + ++-----------+--------------------+ +| *Default* | ``0.5`` | ++-----------+--------------------+ +| *Setter* | set_ao_size(value) | ++-----------+--------------------+ +| *Getter* | get_ao_size() | ++-----------+--------------------+ + +---- + .. _class_GIProbeData_property_bias: - :ref:`float` **bias** +-----------+-----------------+ -| *Default* | ``0.4`` | +| *Default* | ``1.5`` | +-----------+-----------------+ | *Setter* | set_bias(value) | +-----------+-----------------+ @@ -57,68 +116,12 @@ Property Descriptions ---- -.. _class_GIProbeData_property_bounds: - -- :ref:`AABB` **bounds** - -+-----------+------------------------------+ -| *Default* | ``AABB( 0, 0, 0, 1, 1, 1 )`` | -+-----------+------------------------------+ -| *Setter* | set_bounds(value) | -+-----------+------------------------------+ -| *Getter* | get_bounds() | -+-----------+------------------------------+ - ----- - -.. _class_GIProbeData_property_cell_size: - -- :ref:`float` **cell_size** - -+-----------+----------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------+ -| *Setter* | set_cell_size(value) | -+-----------+----------------------+ -| *Getter* | get_cell_size() | -+-----------+----------------------+ - ----- - -.. _class_GIProbeData_property_compress: - -- :ref:`bool` **compress** - -+-----------+---------------------+ -| *Default* | ``false`` | -+-----------+---------------------+ -| *Setter* | set_compress(value) | -+-----------+---------------------+ -| *Getter* | is_compressed() | -+-----------+---------------------+ - ----- - -.. _class_GIProbeData_property_dynamic_data: - -- :ref:`PoolIntArray` **dynamic_data** - -+-----------+-------------------------+ -| *Default* | ``PoolIntArray( )`` | -+-----------+-------------------------+ -| *Setter* | set_dynamic_data(value) | -+-----------+-------------------------+ -| *Getter* | get_dynamic_data() | -+-----------+-------------------------+ - ----- - .. _class_GIProbeData_property_dynamic_range: -- :ref:`int` **dynamic_range** +- :ref:`float` **dynamic_range** +-----------+--------------------------+ -| *Default* | ``1`` | +| *Default* | ``4.0`` | +-----------+--------------------------+ | *Setter* | set_dynamic_range(value) | +-----------+--------------------------+ @@ -160,7 +163,7 @@ Property Descriptions - :ref:`float` **normal_bias** +-----------+------------------------+ -| *Default* | ``0.4`` | +| *Default* | ``0.0`` | +-----------+------------------------+ | *Setter* | set_normal_bias(value) | +-----------+------------------------+ @@ -174,7 +177,7 @@ Property Descriptions - :ref:`float` **propagation** +-----------+------------------------+ -| *Default* | ``1.0`` | +| *Default* | ``0.7`` | +-----------+------------------------+ | *Setter* | set_propagation(value) | +-----------+------------------------+ @@ -183,15 +186,58 @@ Property Descriptions ---- -.. _class_GIProbeData_property_to_cell_xform: +.. _class_GIProbeData_property_use_two_bounces: -- :ref:`Transform` **to_cell_xform** +- :ref:`bool` **use_two_bounces** -+-----------+-----------------------------------------------------+ -| *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | -+-----------+-----------------------------------------------------+ -| *Setter* | set_to_cell_xform(value) | -+-----------+-----------------------------------------------------+ -| *Getter* | get_to_cell_xform() | -+-----------+-----------------------------------------------------+ ++-----------+----------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------+ +| *Setter* | set_use_two_bounces(value) | ++-----------+----------------------------+ +| *Getter* | is_using_two_bounces() | ++-----------+----------------------------+ + +Method Descriptions +------------------- + +.. _class_GIProbeData_method_allocate: + +- void **allocate** **(** :ref:`Transform` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** + +---- + +.. _class_GIProbeData_method_get_bounds: + +- :ref:`AABB` **get_bounds** **(** **)** const + +---- + +.. _class_GIProbeData_method_get_data_cells: + +- :ref:`PackedByteArray` **get_data_cells** **(** **)** const + +---- + +.. _class_GIProbeData_method_get_level_counts: + +- :ref:`PackedInt32Array` **get_level_counts** **(** **)** const + +---- + +.. _class_GIProbeData_method_get_octree_cells: + +- :ref:`PackedByteArray` **get_octree_cells** **(** **)** const + +---- + +.. _class_GIProbeData_method_get_octree_size: + +- :ref:`Vector3` **get_octree_size** **(** **)** const + +---- + +.. _class_GIProbeData_method_get_to_cell_xform: + +- :ref:`Transform` **get_to_cell_xform** **(** **)** const diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index e19424ee1..c59594830 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -21,11 +21,11 @@ Given a set of colors, this resource will interpolate them in order. This means Properties ---------- -+---------------------------------------------+-------------------------------------------------+----------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`colors` | ``PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` | -+---------------------------------------------+-------------------------------------------------+----------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`offsets` | ``PoolRealArray( 0, 1 )`` | -+---------------------------------------------+-------------------------------------------------+----------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------+------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`colors` | ``PackedColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` | ++-----------------------------------------------------+-------------------------------------------------+------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`offsets` | ``PackedFloat32Array( 0, 1 )`` | ++-----------------------------------------------------+-------------------------------------------------+------------------------------------------------+ Methods ------- @@ -53,33 +53,33 @@ Property Descriptions .. _class_Gradient_property_colors: -- :ref:`PoolColorArray` **colors** +- :ref:`PackedColorArray` **colors** -+-----------+----------------------------------------------+ -| *Default* | ``PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` | -+-----------+----------------------------------------------+ -| *Setter* | set_colors(value) | -+-----------+----------------------------------------------+ -| *Getter* | get_colors() | -+-----------+----------------------------------------------+ ++-----------+------------------------------------------------+ +| *Default* | ``PackedColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )`` | ++-----------+------------------------------------------------+ +| *Setter* | set_colors(value) | ++-----------+------------------------------------------------+ +| *Getter* | get_colors() | ++-----------+------------------------------------------------+ -Gradient's colors returned as a :ref:`PoolColorArray`. +Gradient's colors returned as a :ref:`PackedColorArray`. ---- .. _class_Gradient_property_offsets: -- :ref:`PoolRealArray` **offsets** +- :ref:`PackedFloat32Array` **offsets** -+-----------+---------------------------+ -| *Default* | ``PoolRealArray( 0, 1 )`` | -+-----------+---------------------------+ -| *Setter* | set_offsets(value) | -+-----------+---------------------------+ -| *Getter* | get_offsets() | -+-----------+---------------------------+ ++-----------+--------------------------------+ +| *Default* | ``PackedFloat32Array( 0, 1 )`` | ++-----------+--------------------------------+ +| *Setter* | set_offsets(value) | ++-----------+--------------------------------+ +| *Getter* | get_offsets() | ++-----------+--------------------------------+ -Gradient's offsets returned as a :ref:`PoolRealArray`. +Gradient's offsets returned as a :ref:`PackedFloat32Array`. Method Descriptions ------------------- diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 61c6efe02..0843f4534 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -9,7 +9,7 @@ GradientTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Gradient-filled texture. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 93b45f060..8c557fa14 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -42,70 +42,70 @@ Properties Methods ------- -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_connections` **(** **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Node` node **)** | -+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_connections` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_node` **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_node` **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_left_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_connection_activity` **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port, :ref:`float` amount **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Color` | activity | Color( 1, 1, 1, 1 ) | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`int` | bezier_len_neg | 160 | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`int` | bezier_len_pos | 80 | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`StyleBox` | bg | | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Color` | grid_major | Color( 1, 1, 1, 0.2 ) | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Color` | grid_minor | Color( 1, 1, 1, 0.05 ) | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Texture` | minus | | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Texture` | more | | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`int` | port_grab_distance_horizontal | 48 | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`int` | port_grab_distance_vertical | 6 | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Texture` | reset | | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Color` | selection_fill | Color( 1, 1, 1, 0.3 ) | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Color` | selection_stroke | Color( 1, 1, 1, 0.8 ) | -+---------------------------------+-------------------------------+------------------------+ -| :ref:`Texture` | snap | | -+---------------------------------+-------------------------------+------------------------+ ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | activity | Color( 1, 1, 1, 1 ) | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`int` | bezier_len_neg | 160 | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`int` | bezier_len_pos | 80 | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`StyleBox` | bg | | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | grid_major | Color( 1, 1, 1, 0.2 ) | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | grid_minor | Color( 1, 1, 1, 0.05 ) | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Texture2D` | minus | | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Texture2D` | more | | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`int` | port_grab_distance_horizontal | 48 | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`int` | port_grab_distance_vertical | 6 | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Texture2D` | reset | | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | selection_fill | Color( 1, 1, 1, 0.3 ) | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Color` | selection_stroke | Color( 1, 1, 1, 0.8 ) | ++-----------------------------------+-------------------------------+------------------------+ +| :ref:`Texture2D` | snap | | ++-----------------------------------+-------------------------------+------------------------+ Signals ------- @@ -128,7 +128,7 @@ Emitted at the end of a GraphNode movement. .. _class_GraphEdit_signal_connection_from_empty: -- **connection_from_empty** **(** :ref:`String` to, :ref:`int` to_slot, :ref:`Vector2` release_position **)** +- **connection_from_empty** **(** :ref:`StringName` to, :ref:`int` to_slot, :ref:`Vector2` release_position **)** Emitted when user dragging connection from input port into empty space of the graph. @@ -136,7 +136,7 @@ Emitted when user dragging connection from input port into empty space of the gr .. _class_GraphEdit_signal_connection_request: -- **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **connection_request** **(** :ref:`StringName` from, :ref:`int` from_slot, :ref:`StringName` to, :ref:`int` to_slot **)** Emitted to the GraphEdit when the connection between the ``from_slot`` slot of the ``from`` GraphNode and the ``to_slot`` slot of the ``to`` GraphNode is attempted to be created. @@ -144,7 +144,7 @@ Emitted to the GraphEdit when the connection between the ``from_slot`` slot of t .. _class_GraphEdit_signal_connection_to_empty: -- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** +- **connection_to_empty** **(** :ref:`StringName` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** Emitted when user dragging connection from output port into empty space of the graph. @@ -168,7 +168,7 @@ Emitted when a GraphNode is attempted to be removed from the GraphEdit. .. _class_GraphEdit_signal_disconnection_request: -- **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **disconnection_request** **(** :ref:`StringName` from, :ref:`int` from_slot, :ref:`StringName` to, :ref:`int` to_slot **)** Emitted to the GraphEdit when the connection between ``from_slot`` slot of ``from`` GraphNode and ``to_slot`` slot of ``to`` GraphNode is attempted to be removed. @@ -330,7 +330,7 @@ Removes all connections between nodes. .. _class_GraphEdit_method_connect_node: -- :ref:`Error` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`Error` **connect_node** **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** Create a connection between the ``from_port`` slot of the ``from`` GraphNode and the ``to_port`` slot of the ``to`` GraphNode. If the connection already exists, no connection is created. @@ -338,7 +338,7 @@ Create a connection between the ``from_port`` slot of the ``from`` GraphNode and .. _class_GraphEdit_method_disconnect_node: -- void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- void **disconnect_node** **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** Removes the connection between the ``from_port`` slot of the ``from`` GraphNode and the ``to_port`` slot of the ``to`` GraphNode. If the connection does not exist, no connection is removed. @@ -364,7 +364,7 @@ Warning: The intended usage of this function is to allow you to reposition or ad .. _class_GraphEdit_method_is_node_connected: -- :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`bool` **is_node_connected** **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port **)** Returns ``true`` if the ``from_port`` slot of the ``from`` GraphNode is connected to the ``to_port`` slot of the ``to`` GraphNode. @@ -404,7 +404,7 @@ Removes the possibility to disconnect nodes when dragging from the slot at the r .. _class_GraphEdit_method_set_connection_activity: -- void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** +- void **set_connection_activity** **(** :ref:`StringName` from, :ref:`int` from_port, :ref:`StringName` to, :ref:`int` to_port, :ref:`float` amount **)** Sets the coloration of the connection between ``from``'s ``from_port`` and ``to``'s ``to_port`` with the color provided in the ``activity`` theme property. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index f0f4e186f..a1aa26683 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -25,103 +25,105 @@ In the Inspector you can enable (show) or disable (hide) slots. By default all s Properties ---------- -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`comment` | ``false`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`Overlay` | :ref:`overlay` | ``0`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`resizable` | ``false`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`selected` | ``false`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`show_close` | ``false`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ -| :ref:`String` | :ref:`title` | ``""`` | -+----------------------------------------+--------------------------------------------------------+---------------------+ ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`comment` | ``false`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`MouseFilter` | mouse_filter | **O:** ``0`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`Overlay` | :ref:`overlay` | ``0`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`resizable` | ``false`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`selected` | ``false`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`show_close` | ``false`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ +| :ref:`String` | :ref:`title` | ``""`` | ++----------------------------------------------+--------------------------------------------------------+---------------------+ Methods ------- -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all_slots` **(** **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | -+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all_slots` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_slot` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_count` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_count` **(** **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slot_type_right` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_left` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture2D` custom_left=null, :ref:`Texture2D` custom_right=null **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | breakpoint | | -+---------------------------------+---------------+---------------------+ -| :ref:`Texture` | close | | -+---------------------------------+---------------+---------------------+ -| :ref:`Color` | close_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+---------------+---------------------+ -| :ref:`int` | close_offset | 18 | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | comment | | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | commentfocus | | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | defaultfocus | | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | defaultframe | | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | frame | | -+---------------------------------+---------------+---------------------+ -| :ref:`Texture` | port | | -+---------------------------------+---------------+---------------------+ -| :ref:`int` | port_offset | 3 | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | position | | -+---------------------------------+---------------+---------------------+ -| :ref:`Texture` | resizer | | -+---------------------------------+---------------+---------------------+ -| :ref:`Color` | resizer_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+---------------+---------------------+ -| :ref:`StyleBox` | selectedframe | | -+---------------------------------+---------------+---------------------+ -| :ref:`int` | separation | 1 | -+---------------------------------+---------------+---------------------+ -| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+---------------+---------------------+ -| :ref:`Font` | title_font | | -+---------------------------------+---------------+---------------------+ -| :ref:`int` | title_offset | 20 | -+---------------------------------+---------------+---------------------+ ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | breakpoint | | ++-----------------------------------+---------------+---------------------+ +| :ref:`Texture2D` | close | | ++-----------------------------------+---------------+---------------------+ +| :ref:`Color` | close_color | Color( 0, 0, 0, 1 ) | ++-----------------------------------+---------------+---------------------+ +| :ref:`int` | close_offset | 18 | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | comment | | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | commentfocus | | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | defaultfocus | | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | defaultframe | | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | frame | | ++-----------------------------------+---------------+---------------------+ +| :ref:`Texture2D` | port | | ++-----------------------------------+---------------+---------------------+ +| :ref:`int` | port_offset | 3 | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | position | | ++-----------------------------------+---------------+---------------------+ +| :ref:`Texture2D` | resizer | | ++-----------------------------------+---------------+---------------------+ +| :ref:`Color` | resizer_color | Color( 0, 0, 0, 1 ) | ++-----------------------------------+---------------+---------------------+ +| :ref:`StyleBox` | selectedframe | | ++-----------------------------------+---------------+---------------------+ +| :ref:`int` | separation | 1 | ++-----------------------------------+---------------+---------------------+ +| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | ++-----------------------------------+---------------+---------------------+ +| :ref:`Font` | title_font | | ++-----------------------------------+---------------+---------------------+ +| :ref:`int` | title_offset | 20 | ++-----------------------------------+---------------+---------------------+ Signals ------- @@ -435,7 +437,7 @@ Returns ``true`` if right (output) slot ``idx`` is enabled, ``false`` otherwise. .. _class_GraphNode_method_set_slot: -- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** +- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture2D` custom_left=null, :ref:`Texture2D` custom_right=null **)** Sets properties of the slot with ID ``idx``. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 609c1f59e..4ea6779c2 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -23,11 +23,9 @@ Notice that grid layout will preserve the columns and rows for every size of the Properties ---------- -+----------------------------------------------+------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`columns` | ``1`` | -+----------------------------------------------+------------------------------------------------------+--------------+ -| :ref:`MouseFilter` | mouse_filter | **O:** ``1`` | -+----------------------------------------------+------------------------------------------------------+--------------+ ++-----------------------+------------------------------------------------------+-------+ +| :ref:`int` | :ref:`columns` | ``1`` | ++-----------------------+------------------------------------------------------+-------+ Theme Properties ---------------- diff --git a/classes/class_hashingcontext.rst b/classes/class_hashingcontext.rst index 355ea4bfe..6748086b0 100644 --- a/classes/class_hashingcontext.rst +++ b/classes/class_hashingcontext.rst @@ -47,13 +47,13 @@ The :ref:`HashType` enum shows the supported hashi Methods ------- -+-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`finish` **(** **)** | -+-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`start` **(** :ref:`HashType` type **)** | -+-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`update` **(** :ref:`PoolByteArray` chunk **)** | -+-------------------------------------------+----------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`finish` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`start` **(** :ref:`HashType` type **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`update` **(** :ref:`PackedByteArray` chunk **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -79,7 +79,7 @@ Method Descriptions .. _class_HashingContext_method_finish: -- :ref:`PoolByteArray` **finish** **(** **)** +- :ref:`PackedByteArray` **finish** **(** **)** Closes the current context, and return the computed hash. @@ -95,7 +95,7 @@ Starts a new hash computation of the given ``type`` (e.g. :ref:`HASH_SHA256` **update** **(** :ref:`PoolByteArray` chunk **)** +- :ref:`Error` **update** **(** :ref:`PackedByteArray` chunk **)** Updates the computation with the given ``chunk`` of data. diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst index 4f8f47b29..c58ff27b5 100644 --- a/classes/class_heightmapshape.rst +++ b/classes/class_heightmapshape.rst @@ -21,28 +21,28 @@ Height map shape resource, which can be added to a :ref:`PhysicsBody` | :ref:`map_data` | ``PoolRealArray( 0, 0, 0, 0 )`` | -+-------------------------------------------+-----------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`map_depth` | ``2`` | -+-------------------------------------------+-----------------------------------------------------------+---------------------------------+ -| :ref:`int` | :ref:`map_width` | ``2`` | -+-------------------------------------------+-----------------------------------------------------------+---------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------+--------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`map_data` | ``PackedFloat32Array( 0, 0, 0, 0 )`` | ++-----------------------------------------------------+-----------------------------------------------------------+--------------------------------------+ +| :ref:`int` | :ref:`map_depth` | ``2`` | ++-----------------------------------------------------+-----------------------------------------------------------+--------------------------------------+ +| :ref:`int` | :ref:`map_width` | ``2`` | ++-----------------------------------------------------+-----------------------------------------------------------+--------------------------------------+ Property Descriptions --------------------- .. _class_HeightMapShape_property_map_data: -- :ref:`PoolRealArray` **map_data** +- :ref:`PackedFloat32Array` **map_data** -+-----------+---------------------------------+ -| *Default* | ``PoolRealArray( 0, 0, 0, 0 )`` | -+-----------+---------------------------------+ -| *Setter* | set_map_data(value) | -+-----------+---------------------------------+ -| *Getter* | get_map_data() | -+-----------+---------------------------------+ ++-----------+--------------------------------------+ +| *Default* | ``PackedFloat32Array( 0, 0, 0, 0 )`` | ++-----------+--------------------------------------+ +| *Setter* | set_map_data(value) | ++-----------+--------------------------------------+ +| *Getter* | get_map_data() | ++-----------+--------------------------------------+ Height map data, pool array must be of :ref:`map_width` \* :ref:`map_depth` size. diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 9c0791f06..e29d1b97c 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -275,21 +275,29 @@ Method Descriptions - :ref:`bool` **get_flag** **(** :ref:`Flag` flag **)** const +Returns the value of the specified flag. + ---- .. _class_HingeJoint_method_get_param: - :ref:`float` **get_param** **(** :ref:`Param` param **)** const +Returns the value of the specified parameter. + ---- .. _class_HingeJoint_method_set_flag: - void **set_flag** **(** :ref:`Flag` flag, :ref:`bool` enabled **)** +If ``true``, enables the specified flag. + ---- .. _class_HingeJoint_method_set_param: - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +Sets the value of the specified parameter. + diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index 3359a00c7..938b3927c 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -21,23 +21,23 @@ Horizontal version of :ref:`ScrollBar`, which goes from left (m Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement | -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber_pressed | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | scroll | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | scroll_focus | -+---------------------------------+---------------------+ ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | decrement | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | decrement_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_pressed | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | increment | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | increment_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | scroll | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | scroll_focus | ++-----------------------------------+---------------------+ diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index fa039acd3..ddda661f6 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -21,17 +21,17 @@ Horizontal slider. See :ref:`Slider`. This one goes from left (min Theme Properties ---------------- -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber | -+---------------------------------+-------------------+ -| :ref:`StyleBox` | grabber_area | -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber_disabled | -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber_highlight | -+---------------------------------+-------------------+ -| :ref:`StyleBox` | slider | -+---------------------------------+-------------------+ -| :ref:`Texture` | tick | -+---------------------------------+-------------------+ ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber | ++-----------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_area | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber_disabled | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber_highlight | ++-----------------------------------+-------------------+ +| :ref:`StyleBox` | slider | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | tick | ++-----------------------------------+-------------------+ diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index a799a6a74..176083a4e 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -21,13 +21,13 @@ Horizontal split container. See :ref:`SplitContainer`. Thi Theme Properties ---------------- -+---------------------------------+------------+----+ -| :ref:`int` | autohide | 1 | -+---------------------------------+------------+----+ -| :ref:`StyleBox` | bg | | -+---------------------------------+------------+----+ -| :ref:`Texture` | grabber | | -+---------------------------------+------------+----+ -| :ref:`int` | separation | 12 | -+---------------------------------+------------+----+ ++-----------------------------------+------------+----+ +| :ref:`int` | autohide | 1 | ++-----------------------------------+------------+----+ +| :ref:`StyleBox` | bg | | ++-----------------------------------+------------+----+ +| :ref:`Texture2D` | grabber | | ++-----------------------------------+------------+----+ +| :ref:`int` | separation | 12 | ++-----------------------------------+------------+----+ diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index deebe30d4..b3c32f891 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -45,35 +45,35 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_response_code` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_response` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_body_length` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_response_code` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_response_headers` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_status` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_response` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`read_response_body_chunk` **(** **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`String` body="" **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -510,7 +510,7 @@ Returns the response's HTTP status code. .. _class_HTTPClient_method_get_response_headers: -- :ref:`PoolStringArray` **get_response_headers** **(** **)** +- :ref:`PackedStringArray` **get_response_headers** **(** **)** Returns the response headers. @@ -589,7 +589,7 @@ Furthermore, if a key has a ``null`` value, only the key itself is added, withou .. _class_HTTPClient_method_read_response_body_chunk: -- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** +- :ref:`PackedByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. @@ -597,7 +597,7 @@ Reads one chunk from the response. .. _class_HTTPClient_method_request: -- :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** +- :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`String` body="" **)** Sends a request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. @@ -616,7 +616,7 @@ To create a POST request with query strings to push to the server, do: .. _class_HTTPClient_method_request_raw: -- :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** Sends a raw request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 9baa01627..7e46e3884 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -101,24 +101,24 @@ Properties Methods ------- -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cancel_request` **(** **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_body_size` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_http_client_status` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cancel_request` **(** **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_body_size` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_http_client_status` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_HTTPRequest_signal_request_completed: -- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** Emitted when a request is completed. @@ -317,7 +317,7 @@ Returns the current status of the underlying :ref:`HTTPClient` .. _class_HTTPRequest_method_request: -- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** +- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. diff --git a/classes/class_image.rst b/classes/class_image.rst index a12940923..5bd981f80 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -16,121 +16,121 @@ Image datatype. Description ----------- -Native image datatype. Contains image data, which can be converted to a :ref:`Texture`, and several functions to interact with it. The maximum width and height for an ``Image`` are :ref:`MAX_WIDTH` and :ref:`MAX_HEIGHT`. +Native image datatype. Contains image data, which can be converted to a :ref:`Texture2D`, and several functions to interact with it. The maximum width and height for an ``Image`` are :ref:`MAX_WIDTH` and :ref:`MAX_HEIGHT`. Properties ---------- -+-------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`data` | ``{"data": PoolByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0}`` | -+-------------------------------------+----------------------------------------+------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`data` | ``{"data": PackedByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0}`` | ++-------------------------------------+----------------------------------------+--------------------------------------------------------------------------------------------+ Methods ------- -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bumpmap_to_normalmap` **(** :ref:`float` bump_scale=1.0 **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_mipmaps` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert` **(** :ref:`Format` format **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_from` **(** :ref:`Image` src **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`decompress` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`expand_x2_hq2x` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Color` color **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_x` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`flip_y` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_compressed` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_empty` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_invisible` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`normalmap_to_xy` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`premultiply_alpha` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_exr` **(** :ref:`String` path, :ref:`bool` grayscale=false **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shrink_x2` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`srgb_to_linear` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bumpmap_to_normalmap` **(** :ref:`float` bump_scale=1.0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_mipmaps` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source=0, :ref:`float` lossy_quality=0.7 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`compress_from_channels` **(** :ref:`CompressMode` mode, :ref:`CompressSource` channels, :ref:`float` lossy_quality=0.7 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert` **(** :ref:`Format` format **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_from` **(** :ref:`Image` src **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`decompress` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`UsedChannels` | :ref:`detect_used_channels` **(** :ref:`CompressSource` source=0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`expand_x2_hq2x` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Color` color **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_alpha_edges` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_x` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_y` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_data` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_invisible` **(** **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PackedByteArray` buffer **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`normalmap_to_xy` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`premultiply_alpha` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_exr` **(** :ref:`String` path, :ref:`bool` grayscale=false **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shrink_x2` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`srgb_to_linear` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -151,7 +151,7 @@ Enumerations .. _class_Image_constant_FORMAT_RGBA4444: -.. _class_Image_constant_FORMAT_RGBA5551: +.. _class_Image_constant_FORMAT_RGB565: .. _class_Image_constant_FORMAT_RF: @@ -211,6 +211,10 @@ Enumerations .. _class_Image_constant_FORMAT_ETC2_RGB8A1: +.. _class_Image_constant_FORMAT_ETC2_RA_AS_RG: + +.. _class_Image_constant_FORMAT_DXT5_RA_AS_RG: + .. _class_Image_constant_FORMAT_MAX: enum **Format**: @@ -233,7 +237,7 @@ enum **Format**: - **FORMAT_RGBA4444** = **6** --- OpenGL texture format ``RGBA`` with four components, each with a bitdepth of 4. -- **FORMAT_RGBA5551** = **7** --- OpenGL texture format ``GL_RGB5_A1`` where 5 bits of depth for each component of RGB and one bit for alpha. +- **FORMAT_RGB565** = **7** - **FORMAT_RF** = **8** --- OpenGL texture format ``GL_R32F`` where there's one component, a 32-bit floating-point value. @@ -309,7 +313,11 @@ enum **Format**: **Note:** When creating an :ref:`ImageTexture`, an sRGB to linear color space conversion is performed. -- **FORMAT_MAX** = **37** --- Represents the size of the :ref:`Format` enum. +- **FORMAT_ETC2_RA_AS_RG** = **37** + +- **FORMAT_DXT5_RA_AS_RG** = **38** + +- **FORMAT_MAX** = **39** --- Represents the size of the :ref:`Format` enum. ---- @@ -391,6 +399,36 @@ enum **CompressMode**: ---- +.. _enum_Image_UsedChannels: + +.. _class_Image_constant_USED_CHANNELS_L: + +.. _class_Image_constant_USED_CHANNELS_LA: + +.. _class_Image_constant_USED_CHANNELS_R: + +.. _class_Image_constant_USED_CHANNELS_RG: + +.. _class_Image_constant_USED_CHANNELS_RGB: + +.. _class_Image_constant_USED_CHANNELS_RGBA: + +enum **UsedChannels**: + +- **USED_CHANNELS_L** = **0** + +- **USED_CHANNELS_LA** = **1** + +- **USED_CHANNELS_R** = **2** + +- **USED_CHANNELS_RG** = **3** + +- **USED_CHANNELS_RGB** = **4** + +- **USED_CHANNELS_RGBA** = **5** + +---- + .. _enum_Image_CompressSource: .. _class_Image_constant_COMPRESS_SOURCE_GENERIC: @@ -414,9 +452,9 @@ Constants .. _class_Image_constant_MAX_HEIGHT: -- **MAX_WIDTH** = **16384** --- The maximal width allowed for ``Image`` resources. +- **MAX_WIDTH** = **16777216** --- The maximal width allowed for ``Image`` resources. -- **MAX_HEIGHT** = **16384** --- The maximal height allowed for ``Image`` resources. +- **MAX_HEIGHT** = **16777216** --- The maximal height allowed for ``Image`` resources. Property Descriptions --------------------- @@ -425,9 +463,9 @@ Property Descriptions - :ref:`Dictionary` **data** -+-----------+------------------------------------------------------------------------------------------+ -| *Default* | ``{"data": PoolByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0}`` | -+-----------+------------------------------------------------------------------------------------------+ ++-----------+--------------------------------------------------------------------------------------------+ +| *Default* | ``{"data": PackedByteArray( ),"format": "Lum8","height": 0,"mipmaps": false,"width": 0}`` | ++-----------+--------------------------------------------------------------------------------------------+ Holds all of the image's color data in a given format. See :ref:`Format` constants. @@ -484,12 +522,18 @@ Removes the image's mipmaps. .. _class_Image_method_compress: -- :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** +- :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source=0, :ref:`float` lossy_quality=0.7 **)** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See :ref:`CompressMode` and :ref:`CompressSource` constants. ---- +.. _class_Image_method_compress_from_channels: + +- :ref:`Error` **compress_from_channels** **(** :ref:`CompressMode` mode, :ref:`CompressSource` channels, :ref:`float` lossy_quality=0.7 **)** + +---- + .. _class_Image_method_convert: - void **convert** **(** :ref:`Format` format **)** @@ -516,7 +560,7 @@ Creates an empty image of given size and format. See :ref:`Format` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** +- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PackedByteArray` data **)** Creates a new image of given size and format. See :ref:`Format` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the :ref:`generate_mipmaps`. @@ -546,6 +590,12 @@ Returns :ref:`ALPHA_BLEND` if the image has da ---- +.. _class_Image_method_detect_used_channels: + +- :ref:`UsedChannels` **detect_used_channels** **(** :ref:`CompressSource` source=0 **)** + +---- + .. _class_Image_method_expand_x2_hq2x: - void **expand_x2_hq2x** **(** **)** @@ -596,7 +646,7 @@ Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution .. _class_Image_method_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PackedByteArray` **get_data** **(** **)** const Returns the image's raw data. @@ -630,7 +680,7 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t - :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const -Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixelv`, but two integer arguments instead of a Vector2 argument. +Returns the color of the pixel at ``(x, y)``. This is the same as :ref:`get_pixelv`, but with two integer arguments instead of a :ref:`Vector2` argument. ---- @@ -638,7 +688,7 @@ Returns the color of the pixel at ``(x, y)`` if the image is locked. If the imag - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const -Returns the color of the pixel at ``src`` if the image is locked. If the image is unlocked, it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. This is the same as :ref:`get_pixel`, but with a Vector2 argument instead of two integer arguments. +Returns the color of the pixel at ``src``. This is the same as :ref:`get_pixel`, but with a :ref:`Vector2` argument instead of two integer arguments. ---- @@ -716,7 +766,7 @@ Loads an image from file ``path``. .. _class_Image_method_load_jpg_from_buffer: -- :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PackedByteArray` buffer **)** Loads an image from the binary contents of a JPEG file. @@ -724,7 +774,7 @@ Loads an image from the binary contents of a JPEG file. .. _class_Image_method_load_png_from_buffer: -- :ref:`Error` **load_png_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_png_from_buffer** **(** :ref:`PackedByteArray` buffer **)** Loads an image from the binary contents of a PNG file. @@ -732,20 +782,12 @@ Loads an image from the binary contents of a PNG file. .. _class_Image_method_load_webp_from_buffer: -- :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_webp_from_buffer** **(** :ref:`PackedByteArray` buffer **)** Loads an image from the binary contents of a WebP file. ---- -.. _class_Image_method_lock: - -- void **lock** **(** **)** - -Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel. - ----- - .. _class_Image_method_normalmap_to_xy: - void **normalmap_to_xy** **(** **)** @@ -806,16 +848,13 @@ Saves the image as a PNG file to ``path``. - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** -Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is locked. Example: +Sets the :ref:`Color` of the pixel at ``(x, y)``. Example: :: var img = Image.new() img.create(img_width, img_height, false, Image.FORMAT_RGBA8) - img.lock() - img.set_pixel(x, y, color) # Works - img.unlock() - img.set_pixel(x, y, color) # Does not have an effect + img.set_pixel(x, y, color) ---- @@ -823,16 +862,13 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo - void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** -Sets the :ref:`Color` of the pixel at ``(dst.x, dst.y)`` if the image is locked. Note that the ``dst`` values must be integers. Example: +Sets the :ref:`Color` of the pixel at ``(dst.x, dst.y)``. Note that the ``dst`` values must be integers. Example: :: var img = Image.new() img.create(img_width, img_height, false, Image.FORMAT_RGBA8) - img.lock() - img.set_pixelv(Vector2(x, y), color) # Works - img.unlock() - img.set_pixelv(Vector2(x, y), color) # Does not have an effect + img.set_pixelv(Vector2(x, y), color) ---- @@ -850,11 +886,3 @@ Shrinks the image by a factor of 2. Converts the raw data from the sRGB colorspace to a linear scale. ----- - -.. _class_Image_method_unlock: - -- void **unlock** **(** **)** - -Unlocks the data and prevents changes. - diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 7ab37aa43..38259df44 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -9,113 +9,36 @@ ImageTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -A :ref:`Texture` based on an :ref:`Image`. +A :ref:`Texture2D` based on an :ref:`Image`. Description ----------- -A :ref:`Texture` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. - -Properties ----------- - -+-------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`int` | flags | **O:** ``7`` | -+-------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`lossy_quality` | ``0.7`` | -+-------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`Storage` | :ref:`storage` | ``0`` | -+-------------------------------------------+-----------------------------------------------------------------+--------------+ +A :ref:`Texture2D` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. Methods ------- -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_ImageTexture_Storage: - -.. _class_ImageTexture_constant_STORAGE_RAW: - -.. _class_ImageTexture_constant_STORAGE_COMPRESS_LOSSY: - -.. _class_ImageTexture_constant_STORAGE_COMPRESS_LOSSLESS: - -enum **Storage**: - -- **STORAGE_RAW** = **0** --- :ref:`Image` data is stored raw and unaltered. - -- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`lossy_quality`. - -- **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image` data is compressed with a lossless algorithm. - -Property Descriptions ---------------------- - -.. _class_ImageTexture_property_lossy_quality: - -- :ref:`float` **lossy_quality** - -+-----------+----------------------------------+ -| *Default* | ``0.7`` | -+-----------+----------------------------------+ -| *Setter* | set_lossy_storage_quality(value) | -+-----------+----------------------------------+ -| *Getter* | get_lossy_storage_quality() | -+-----------+----------------------------------+ - -The storage quality for :ref:`STORAGE_COMPRESS_LOSSY`. - ----- - -.. _class_ImageTexture_property_storage: - -- :ref:`Storage` **storage** - -+-----------+--------------------+ -| *Default* | ``0`` | -+-----------+--------------------+ -| *Setter* | set_storage(value) | -+-----------+--------------------+ -| *Getter* | get_storage() | -+-----------+--------------------+ - -The storage type (raw, lossy, or compressed). ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_image` **(** :ref:`Image` image **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** :ref:`Image` image, :ref:`bool` immediate=false **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_ImageTexture_method_create: - -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** - -Create a new ``ImageTexture`` with ``width`` and ``height``. - -``format`` is a value from :ref:`Format`, ``flags`` is any combination of :ref:`Flags`. - ----- - .. _class_ImageTexture_method_create_from_image: -- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- void **create_from_image** **(** :ref:`Image` image **)** -Create a new ``ImageTexture`` from an :ref:`Image` with ``flags`` from :ref:`Flags`. An sRGB to linear color space conversion can take place, according to :ref:`Format`. +Create a new ``ImageTexture`` from an :ref:`Image`. ---- @@ -127,25 +50,17 @@ Returns the format of the ``ImageTexture``, one of :ref:`Format` **load** **(** :ref:`String` path **)** - -Load an ``ImageTexture`` from a file path. - ----- - -.. _class_ImageTexture_method_set_data: - -- void **set_data** **(** :ref:`Image` image **)** - -Sets the :ref:`Image` of this ``ImageTexture``. - ----- - .. _class_ImageTexture_method_set_size_override: - void **set_size_override** **(** :ref:`Vector2` size **)** Resizes the ``ImageTexture`` to the specified dimensions. +---- + +.. _class_ImageTexture_method_update: + +- void **update** **(** :ref:`Image` image, :ref:`bool` immediate=false **)** + +Replaces the texture's data with a new ``image``. If ``immediate`` is ``true``, it will take effect immediately after the call. + diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index e3b4f8192..7cc14c314 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -26,7 +26,7 @@ Methods +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** | +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture2D` texture=null **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,7 +64,7 @@ Adds a vertex in local coordinate space with the currently set color/uv/etc. .. _class_ImmediateGeometry_method_begin: -- void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** +- void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture2D` texture=null **)** Begin drawing (and optionally pass a texture override). When done call :ref:`end`. For more information on how this works, search for ``glBegin()`` and ``glEnd()`` references. diff --git a/classes/class_input.rst b/classes/class_input.rst index 7bd09e5a7..efc229ccd 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -29,15 +29,15 @@ Methods ------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | +| void | :ref:`action_press` **(** :ref:`StringName` action, :ref:`float` strength=1.0 **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | +| void | :ref:`action_release` **(** :ref:`StringName` action **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`StringName` action **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,17 +73,17 @@ Methods +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`StringName` action **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`StringName` action **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`StringName` action **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` keycode **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -221,7 +221,7 @@ Method Descriptions .. _class_Input_method_action_press: -- void **action_press** **(** :ref:`String` action, :ref:`float` strength=1.0 **)** +- void **action_press** **(** :ref:`StringName` action, :ref:`float` strength=1.0 **)** This will simulate pressing the specified action. @@ -233,7 +233,7 @@ The strength can be used for non-boolean actions, it's ranged between 0 and 1 re .. _class_Input_method_action_release: -- void **action_release** **(** :ref:`String` action **)** +- void **action_release** **(** :ref:`StringName` action **)** If the specified action is already pressed, this will release it. @@ -259,7 +259,7 @@ Note this method returns an empty :ref:`Vector3` when running fro .. _class_Input_method_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`StringName` action **)** const Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. @@ -403,7 +403,7 @@ Returns the mouse mode. See the constants for more information. .. _class_Input_method_is_action_just_pressed: -- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_pressed** **(** :ref:`StringName` action **)** 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. @@ -413,7 +413,7 @@ This is useful for code that needs to run only once when an action is pressed, i .. _class_Input_method_is_action_just_released: -- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_released** **(** :ref:`StringName` action **)** 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. @@ -421,7 +421,7 @@ Returns ``true`` when the user stops pressing the action event, meaning it's ``t .. _class_Input_method_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`StringName` action **)** const Returns ``true`` if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. @@ -445,9 +445,9 @@ Returns ``true`` if the system knows the specified device. This means that it se .. _class_Input_method_is_key_pressed: -- :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const +- :ref:`bool` **is_key_pressed** **(** :ref:`int` keycode **)** const -Returns ``true`` if you are pressing the key. You can pass a :ref:`KeyList` constant. +Returns ``true`` if you are pressing the key in the current keyboard layout. You can pass a :ref:`KeyList` constant. ---- @@ -534,7 +534,9 @@ Sets the mouse mode. See the constants for more information. - void **set_use_accumulated_input** **(** :ref:`bool` enable **)** -Whether to accumulate similar input events sent by the operating system. Enabled by default. +Enables or disables the accumulation of similar input events sent by the operating system. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. + +Input accumulation is enabled by default. It can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input. ---- diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 7fe812942..1da53a7bb 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -42,13 +42,13 @@ Methods +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`as_text` **(** **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`StringName` action **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action` **(** :ref:`StringName` action **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** const | +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`StringName` action, :ref:`bool` allow_echo=false **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`StringName` action **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_type` **(** **)** const | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -103,7 +103,7 @@ Returns a :ref:`String` representation of the event. .. _class_InputEvent_method_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`StringName` action **)** const Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion`. @@ -111,7 +111,7 @@ Returns a value between 0.0 and 1.0 depending on the given actions' state. Usefu .. _class_InputEvent_method_is_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action** **(** :ref:`StringName` action **)** const Returns ``true`` if this input event matches a pre-defined action of any type. @@ -119,7 +119,7 @@ Returns ``true`` if this input event matches a pre-defined action of any type. .. _class_InputEvent_method_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action, :ref:`bool` allow_echo=false **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`StringName` action, :ref:`bool` allow_echo=false **)** const Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. @@ -127,7 +127,7 @@ Returns ``true`` if the given action is being pressed (and is not an echo event .. _class_InputEvent_method_is_action_released: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_released** **(** :ref:`StringName` action **)** const Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion` or :ref:`InputEventScreenDrag`. diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index c7cff69b3..20b6d8456 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -26,23 +26,23 @@ Tutorials Properties ---------- -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`action` | ``""`` | -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`pressed` | ``false`` | -+-----------------------------+-----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`strength` | ``1.0`` | -+-----------------------------+-----------------------------------------------------------+-----------+ ++-------------------------------------+-----------------------------------------------------------+-----------+ +| :ref:`StringName` | :ref:`action` | ``@""`` | ++-------------------------------------+-----------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`pressed` | ``false`` | ++-------------------------------------+-----------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`strength` | ``1.0`` | ++-------------------------------------+-----------------------------------------------------------+-----------+ Property Descriptions --------------------- .. _class_InputEventAction_property_action: -- :ref:`String` **action** +- :ref:`StringName` **action** +-----------+-------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+-------------------+ | *Setter* | set_action(value) | +-----------+-------------------+ diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 0b2142356..c54267cf5 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -13,7 +13,7 @@ InputEventGesture **Inherited By:** :ref:`InputEventMagnifyGesture`, :ref:`InputEventPanGesture` - +Base class for touch control gestures. Properties ---------- @@ -37,3 +37,5 @@ Property Descriptions | *Getter* | get_position() | +-----------+---------------------+ +The local gesture position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input`, the position is relative to the current :ref:`Control` that received this gesture. + diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index fd6e42a95..81bf9fe81 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -26,22 +26,26 @@ Tutorials Properties ---------- -+-------------------------+--------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`echo` | ``false`` | -+-------------------------+--------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`pressed` | ``false`` | -+-------------------------+--------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`scancode` | ``0`` | -+-------------------------+--------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`unicode` | ``0`` | -+-------------------------+--------------------------------------------------------+-----------+ ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`echo` | ``false`` | ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`keycode` | ``0`` | ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`physical_keycode` | ``0`` | ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`pressed` | ``false`` | ++-------------------------+------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`unicode` | ``0`` | ++-------------------------+------------------------------------------------------------------------+-----------+ Methods ------- -+-----------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | -+-----------------------+--------------------------------------------------------------------------------------------------------------+ ++-----------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_keycode_with_modifiers` **(** **)** const | ++-----------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_physical_keycode_with_modifiers` **(** **)** const | ++-----------------------+------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -62,6 +66,42 @@ If ``true``, the key was already pressed before this event. It means the user is ---- +.. _class_InputEventKey_property_keycode: + +- :ref:`int` **keycode** + ++-----------+--------------------+ +| *Default* | ``0`` | ++-----------+--------------------+ +| *Setter* | set_keycode(value) | ++-----------+--------------------+ +| *Getter* | get_keycode() | ++-----------+--------------------+ + +The key keycode, which corresponds to one of the :ref:`KeyList` constants. Represent key in the current keyboard layout. + +To get a human-readable representation of the ``InputEventKey``, use ``OS.get_keycode_string(event.keycode)`` where ``event`` is the ``InputEventKey``. + +---- + +.. _class_InputEventKey_property_physical_keycode: + +- :ref:`int` **physical_keycode** + ++-----------+-----------------------------+ +| *Default* | ``0`` | ++-----------+-----------------------------+ +| *Setter* | set_physical_keycode(value) | ++-----------+-----------------------------+ +| *Getter* | get_physical_keycode() | ++-----------+-----------------------------+ + +Key physical keycode, which corresponds to one of the :ref:`KeyList` constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard. + +To get a human-readable representation of the ``InputEventKey``, use ``OS.get_keycode_string(event.keycode)`` where ``event`` is the ``InputEventKey``. + +---- + .. _class_InputEventKey_property_pressed: - :ref:`bool` **pressed** @@ -78,24 +118,6 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas ---- -.. _class_InputEventKey_property_scancode: - -- :ref:`int` **scancode** - -+-----------+---------------------+ -| *Default* | ``0`` | -+-----------+---------------------+ -| *Setter* | set_scancode(value) | -+-----------+---------------------+ -| *Getter* | get_scancode() | -+-----------+---------------------+ - -The key scancode, which corresponds to one of the :ref:`KeyList` constants. - -To get a human-readable representation of the ``InputEventKey``, use ``OS.get_scancode_string(event.scancode)`` where ``event`` is the ``InputEventKey``. - ----- - .. _class_InputEventKey_property_unicode: - :ref:`int` **unicode** @@ -113,11 +135,21 @@ The key Unicode identifier (when relevant). Unicode identifiers for the composit Method Descriptions ------------------- -.. _class_InputEventKey_method_get_scancode_with_modifiers: +.. _class_InputEventKey_method_get_keycode_with_modifiers: -- :ref:`int` **get_scancode_with_modifiers** **(** **)** const +- :ref:`int` **get_keycode_with_modifiers** **(** **)** const -Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. +Returns the keycode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. -To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_scancode_string(event.get_scancode_with_modifiers())`` where ``event`` is the ``InputEventKey``. +To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_keycode_string(event.get_keycode_with_modifiers())`` where ``event`` is the ``InputEventKey``. + +---- + +.. _class_InputEventKey_method_get_physical_keycode_with_modifiers: + +- :ref:`int` **get_physical_keycode_with_modifiers** **(** **)** const + +Returns the physical keycode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. + +To get a human-readable representation of the ``InputEventKey`` with modifiers, use ``OS.get_keycode_string(event.get_physical_keycode_with_modifiers())`` where ``event`` is the ``InputEventKey``. diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 5ff0b8429..a9adbbf64 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -26,38 +26,38 @@ Tutorials Methods ------- -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_events` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`load_from_globals` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_add_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_events` **(** :ref:`StringName` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`StringName` action, :ref:`InputEvent` event **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_set_deadzone` **(** :ref:`StringName` action, :ref:`float` deadzone **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_action` **(** :ref:`StringName` action, :ref:`float` deadzone=0.5 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_action` **(** :ref:`StringName` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`StringName` action **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`StringName` action **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_actions` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_action` **(** :ref:`StringName` action **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load_from_globals` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_InputMap_method_action_add_event: -- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_add_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. @@ -65,7 +65,7 @@ Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent< .. _class_InputMap_method_action_erase_event: -- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_erase_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** Removes an :ref:`InputEvent` from an action. @@ -73,7 +73,7 @@ Removes an :ref:`InputEvent` from an action. .. _class_InputMap_method_action_erase_events: -- void **action_erase_events** **(** :ref:`String` action **)** +- void **action_erase_events** **(** :ref:`StringName` action **)** Removes all events from an action. @@ -81,7 +81,7 @@ Removes all events from an action. .. _class_InputMap_method_action_has_event: -- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- :ref:`bool` **action_has_event** **(** :ref:`StringName` action, :ref:`InputEvent` event **)** Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. @@ -89,7 +89,7 @@ Returns ``true`` if the action has the given :ref:`InputEvent` .. _class_InputMap_method_action_set_deadzone: -- void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** +- void **action_set_deadzone** **(** :ref:`StringName` action, :ref:`float` deadzone **)** Sets a deadzone value for the action. @@ -97,7 +97,7 @@ Sets a deadzone value for the action. .. _class_InputMap_method_add_action: -- void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** +- void **add_action** **(** :ref:`StringName` action, :ref:`float` deadzone=0.5 **)** Adds an empty action to the ``InputMap`` with a configurable ``deadzone``. @@ -107,7 +107,7 @@ An :ref:`InputEvent` can then be added to this action with :re .. _class_InputMap_method_erase_action: -- void **erase_action** **(** :ref:`String` action **)** +- void **erase_action** **(** :ref:`StringName` action **)** Removes an action from the ``InputMap``. @@ -115,7 +115,7 @@ Removes an action from the ``InputMap``. .. _class_InputMap_method_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`StringName` action **)** const Returns ``true`` if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. @@ -123,7 +123,7 @@ Returns ``true`` if the given event is part of an existing action. This method i .. _class_InputMap_method_get_action_list: -- :ref:`Array` **get_action_list** **(** :ref:`String` action **)** +- :ref:`Array` **get_action_list** **(** :ref:`StringName` action **)** Returns an array of :ref:`InputEvent`\ s associated with a given action. @@ -139,7 +139,7 @@ Returns an array of all actions in the ``InputMap``. .. _class_InputMap_method_has_action: -- :ref:`bool` **has_action** **(** :ref:`String` action **)** const +- :ref:`bool` **has_action** **(** :ref:`StringName` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 0f9d452dd..0fb21376d 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -16,9 +16,9 @@ Placeholder for the root :ref:`Node` of a :ref:`PackedScene`. This is useful to avoid loading large scenes all at once by loading parts of it selectively. +Turning on the option **Load As Placeholder** for an instanced scene in the editor causes it to be replaced by an ``InstancePlaceholder`` when running the game. This makes it possible to delay actually loading the scene until calling :ref:`create_instance`. This is useful to avoid loading large scenes all at once by loading parts of it selectively. -The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. +The ``InstancePlaceholder`` does not have a transform. This causes any child nodes to be positioned relatively to the :ref:`Viewport` from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. Methods ------- @@ -30,8 +30,6 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -46,7 +44,7 @@ Method Descriptions - :ref:`String` **get_instance_path** **(** **)** const -Gets the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. +Gets the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`create_instance`. ---- @@ -54,11 +52,3 @@ Gets the path to the :ref:`PackedScene` resource file that is - :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** ----- - -.. _class_InstancePlaceholder_method_replace_by_instance: - -- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** - -Replaces this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. - diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 186cd7c19..e5a8ffd17 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -56,87 +56,87 @@ Properties Methods ------- -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_current_is_visible` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_anything_selected` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_icon_transposed` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_item` **(** :ref:`int` from_idx, :ref:`int` to_idx **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_transposed` **(** :ref:`int` idx, :ref:`bool` transposed **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_items_by_text` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect` **(** :ref:`int` idx **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unselect_all` **(** **)** | -+-----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture2D` icon, :ref:`bool` selectable=true **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture2D` icon=null, :ref:`bool` selectable=true **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_current_is_visible` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_selected_items` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_anything_selected` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_icon_transposed` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_selectable` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_tooltip_enabled` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` idx **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_item` **(** :ref:`int` from_idx, :ref:`int` to_idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` icon **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon_transposed` **(** :ref:`int` idx, :ref:`bool` transposed **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_items_by_text` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect` **(** :ref:`int` idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unselect_all` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -451,7 +451,7 @@ Method Descriptions .. _class_ItemList_method_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** +- void **add_icon_item** **(** :ref:`Texture2D` icon, :ref:`bool` selectable=true **)** Adds an item to the item list with no text, only an icon. @@ -459,7 +459,7 @@ Adds an item to the item list with no text, only an icon. .. _class_ItemList_method_add_item: -- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** +- void **add_item** **(** :ref:`String` text, :ref:`Texture2D` icon=null, :ref:`bool` selectable=true **)** Adds an item to the item list with specified text. Specify an ``icon``, or use ``null`` as the ``icon`` for a list item with no icon. @@ -519,7 +519,7 @@ Returns the custom foreground color of the item specified by ``idx`` index. .. _class_ItemList_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon associated with the specified index. @@ -567,7 +567,7 @@ Returns the tooltip hint associated with the specified index. .. _class_ItemList_method_get_selected_items: -- :ref:`PoolIntArray` **get_selected_items** **(** **)** +- :ref:`PackedInt32Array` **get_selected_items** **(** **)** Returns an array with the indexes of the selected items. @@ -693,9 +693,9 @@ Disabled items cannot be selected and do not trigger activation signals (when do .. _class_ItemList_method_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture2D` icon **)** -Sets (or replaces) the icon's :ref:`Texture` associated with the specified index. +Sets (or replaces) the icon's :ref:`Texture2D` associated with the specified index. ---- diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 841d0069a..adfef9aa8 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -219,7 +219,9 @@ If ``test_only`` is ``true``, the body does not move but the would-be collision Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is the velocity vector (typically meters per second). Unlike in :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — the physics engine handles applying the velocity. +This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. + +``linear_velocity`` is the velocity vector (typically meters per second). Unlike in :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — the physics engine handles applying the velocity. ``up_direction`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector3(0, 0, 0)``, everything is considered a wall. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 06cef4cb6..84194dbc1 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -181,7 +181,9 @@ If ``test_only`` is ``true``, the body does not move but the would-be collision Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is the velocity vector in pixels per second. Unlike in :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — the physics engine handles applying the velocity. +This method should be used in :ref:`Node._physics_process` (or in a method called by :ref:`Node._physics_process`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. + +``linear_velocity`` is the velocity vector in pixels per second. Unlike in :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — the physics engine handles applying the velocity. ``up_direction`` is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of ``Vector2(0, 0)``, everything is considered a wall. This is useful for topdown games. diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index 3dce7d3de..26b90f31b 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -9,51 +9,44 @@ LargeTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -A :ref:`Texture` capable of storing many smaller textures with offsets. +A :ref:`Texture2D` capable of storing many smaller textures with offsets. Description ----------- -A :ref:`Texture` capable of storing many smaller textures with offsets. +A :ref:`Texture2D` capable of storing many smaller textures with offsets. -You can dynamically add pieces (:ref:`Texture`\ s) to this ``LargeTexture`` using different offsets. - -Properties ----------- - -+-----------------------+-------+--------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-----------------------+-------+--------------+ +You can dynamically add pieces (:ref:`Texture2D`\ s) to this ``LargeTexture`` using different offsets. Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_piece_count` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture2D` texture **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_piece_count` **(** **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture2D` texture **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_LargeTexture_method_add_piece: -- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** +- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture2D` texture **)** Adds ``texture`` to this ``LargeTexture``, starting on offset ``ofs``. @@ -85,9 +78,9 @@ Returns the offset of the piece with the index ``idx``. .. _class_LargeTexture_method_get_piece_texture: -- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture2D` **get_piece_texture** **(** :ref:`int` idx **)** const -Returns the :ref:`Texture` of the piece with the index ``idx``. +Returns the :ref:`Texture2D` of the piece with the index ``idx``. ---- @@ -101,9 +94,9 @@ Sets the offset of the piece with the index ``idx`` to ``ofs``. .. _class_LargeTexture_method_set_piece_texture: -- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture2D` texture **)** -Sets the :ref:`Texture` of the piece with index ``idx`` to ``texture``. +Sets the :ref:`Texture2D` of the piece with index ``idx`` to ``texture``. ---- diff --git a/classes/class_light.rst b/classes/class_light.rst index e6894e61d..82f231ca7 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -94,6 +94,8 @@ Enumerations .. _class_Light_constant_PARAM_SHADOW_SPLIT_3_OFFSET: +.. _class_Light_constant_PARAM_SHADOW_FADE_START: + .. _class_Light_constant_PARAM_SHADOW_NORMAL_BIAS: .. _class_Light_constant_PARAM_SHADOW_BIAS: @@ -128,13 +130,15 @@ enum **Param**: - **PARAM_SHADOW_SPLIT_3_OFFSET** = **11** --- Constant for accessing :ref:`DirectionalLight.directional_shadow_split_3`. -- **PARAM_SHADOW_NORMAL_BIAS** = **12** --- Constant for accessing :ref:`DirectionalLight.directional_shadow_normal_bias`. +- **PARAM_SHADOW_FADE_START** = **12** -- **PARAM_SHADOW_BIAS** = **13** --- Constant for accessing :ref:`shadow_bias`. +- **PARAM_SHADOW_NORMAL_BIAS** = **13** --- Constant for accessing :ref:`DirectionalLight.directional_shadow_normal_bias`. -- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** --- Constant for accessing :ref:`DirectionalLight.directional_shadow_bias_split_scale`. +- **PARAM_SHADOW_BIAS** = **14** --- Constant for accessing :ref:`shadow_bias`. -- **PARAM_MAX** = **15** --- Represents the size of the :ref:`Param` enum. +- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **15** --- Constant for accessing :ref:`DirectionalLight.directional_shadow_bias_split_scale`. + +- **PARAM_MAX** = **16** --- Represents the size of the :ref:`Param` enum. ---- @@ -253,7 +257,7 @@ The light's strength multiplier. | *Getter* | get_param() | +-----------+------------------+ -Secondary multiplier used with indirect light (light bounces). This works on both :ref:`BakedLightmap` and :ref:`GIProbe`. +Secondary multiplier used with indirect light (light bounces). Used with :ref:`GIProbe`. ---- diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index a4da9ad4c..fb407ffa8 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -28,49 +28,47 @@ Tutorials Properties ---------- -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`editor_only` | ``false`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`enabled` | ``true`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`energy` | ``1.0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`Mode` | :ref:`mode` | ``0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`range_height` | ``0.0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`range_item_cull_mask` | ``1`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`range_layer_max` | ``0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`range_layer_min` | ``0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`range_z_max` | ``1024`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`range_z_min` | ``-1024`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`shadow_buffer_size` | ``2048`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`Color` | :ref:`shadow_color` | ``Color( 0, 0, 0, 0 )`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`shadow_enabled` | ``false`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`ShadowFilter` | :ref:`shadow_filter` | ``0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`shadow_filter_smooth` | ``0.0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`shadow_gradient_length` | ``0.0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`shadow_item_cull_mask` | ``1`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`texture_scale` | ``1.0`` | -+------------------------------------------------+------------------------------------------------------------------------------+-------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`editor_only` | ``false`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`energy` | ``1.0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`Mode` | :ref:`mode` | ``0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`range_height` | ``0.0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`range_item_cull_mask` | ``1`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`range_layer_max` | ``0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`range_layer_min` | ``0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`range_z_max` | ``1024`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`range_z_min` | ``-1024`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`shadow_buffer_size` | ``2048`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`shadow_color` | ``Color( 0, 0, 0, 0 )`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`shadow_enabled` | ``false`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`ShadowFilter` | :ref:`shadow_filter` | ``0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`shadow_filter_smooth` | ``0.0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`shadow_item_cull_mask` | ``1`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`texture` | | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`texture_scale` | ``1.0`` | ++------------------------------------------------+----------------------------------------------------------------------------+-------------------------+ Enumerations ------------ @@ -101,29 +99,17 @@ enum **Mode**: .. _class_Light2D_constant_SHADOW_FILTER_NONE: -.. _class_Light2D_constant_SHADOW_FILTER_PCF3: - .. _class_Light2D_constant_SHADOW_FILTER_PCF5: -.. _class_Light2D_constant_SHADOW_FILTER_PCF7: - -.. _class_Light2D_constant_SHADOW_FILTER_PCF9: - .. _class_Light2D_constant_SHADOW_FILTER_PCF13: enum **ShadowFilter**: - **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF5** = **1** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. - -- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. - -- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. - -- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF13** = **2** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. Property Descriptions --------------------- @@ -400,22 +386,6 @@ Smoothing value for shadows. ---- -.. _class_Light2D_property_shadow_gradient_length: - -- :ref:`float` **shadow_gradient_length** - -+-----------+-----------------------------------+ -| *Default* | ``0.0`` | -+-----------+-----------------------------------+ -| *Setter* | set_shadow_gradient_length(value) | -+-----------+-----------------------------------+ -| *Getter* | get_shadow_gradient_length() | -+-----------+-----------------------------------+ - -Smooth shadow gradient length. - ----- - .. _class_Light2D_property_shadow_item_cull_mask: - :ref:`int` **shadow_item_cull_mask** @@ -434,7 +404,7 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast .. _class_Light2D_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -442,7 +412,7 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast | *Getter* | get_texture() | +----------+--------------------+ -:ref:`Texture` used for the Light2D's appearance. +:ref:`Texture2D` used for the Light2D's appearance. ---- diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 87df24f2d..117b054b0 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -18,8 +18,6 @@ Description A line through several points in 2D space. -**Note:** By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb` and :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb`. - Properties ---------- @@ -36,13 +34,13 @@ Properties +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ | :ref:`LineJointMode` | :ref:`joint_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ -| :ref:`PoolVector2Array` | :ref:`points` | ``PoolVector2Array( )`` | +| :ref:`PackedVector2Array` | :ref:`points` | ``PackedVector2Array( )`` | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ | :ref:`int` | :ref:`round_precision` | ``8`` | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ | :ref:`float` | :ref:`sharp_limit` | ``2.0`` | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ | :ref:`LineTextureMode` | :ref:`texture_mode` | ``0`` | +-----------------------------------------------------+---------------------------------------------------------------+-----------------------------+ @@ -222,15 +220,15 @@ The style for the points between the start and the end. .. _class_Line2D_property_points: -- :ref:`PoolVector2Array` **points** +- :ref:`PackedVector2Array` **points** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_points(value) | -+-----------+--------------------------+ -| *Getter* | get_points() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_points(value) | ++-----------+----------------------------+ +| *Getter* | get_points() | ++-----------+----------------------------+ The points that form the lines. The line is drawn between every point set in this array. @@ -270,7 +268,7 @@ The direction difference in radians between vector points. This value is only us .. _class_Line2D_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index a6077b46e..d69606568 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -52,6 +52,10 @@ On macOS, some extra keyboard shortcuts are available: - Ctrl + H: Like the Backspace key, delete the character on the left side of the cursor +- Ctrl + A: Like the Home key, move the cursor to the beginning of the line + +- Ctrl + E: Like the End key, move the cursor to the end of the line + - Command + Left arrow: Like the Home key, move the cursor to the beginning of the line - Command + Right arrow: Like the End key, move the cursor to the end of the line @@ -86,7 +90,7 @@ Properties +----------------------------------------------+-----------------------------------------------------------------------------+--------------+ | :ref:`String` | :ref:`placeholder_text` | ``""`` | +----------------------------------------------+-----------------------------------------------------------------------------+--------------+ -| :ref:`Texture` | :ref:`right_icon` | | +| :ref:`Texture2D` | :ref:`right_icon` | | +----------------------------------------------+-----------------------------------------------------------------------------+--------------+ | :ref:`bool` | :ref:`secret` | ``false`` | +----------------------------------------------+-----------------------------------------------------------------------------+--------------+ @@ -121,33 +125,33 @@ Methods Theme Properties ---------------- -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Texture` | clear | | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | clear_button_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | clear_button_color_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | cursor_color | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | font_color_uneditable | Color( 0.88, 0.88, 0.88, 0.5 ) | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`int` | minimum_spaces | 12 | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`StyleBox` | read_only | | -+---------------------------------+----------------------------+--------------------------------+ -| :ref:`Color` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) | -+---------------------------------+----------------------------+--------------------------------+ ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Texture2D` | clear | | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | clear_button_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | clear_button_color_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | cursor_color | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | font_color_uneditable | Color( 0.88, 0.88, 0.88, 0.5 ) | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`int` | minimum_spaces | 12 | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`StyleBox` | read_only | | ++-----------------------------------+----------------------------+--------------------------------+ +| :ref:`Color` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) | ++-----------------------------------+----------------------------+--------------------------------+ Signals ------- @@ -418,7 +422,7 @@ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s defa .. _class_LineEdit_property_right_icon: -- :ref:`Texture` **right_icon** +- :ref:`Texture2D` **right_icon** +----------+-----------------------+ | *Setter* | set_right_icon(value) | diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index d472735ea..075fa3eb4 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -21,11 +21,11 @@ Line shape for 2D collisions. It works like a 2D plane and will not allow any ph Properties ---------- -+-------------------------------+--------------------------------------------------+----------------------+ -| :ref:`float` | :ref:`d` | ``0.0`` | -+-------------------------------+--------------------------------------------------+----------------------+ -| :ref:`Vector2` | :ref:`normal` | ``Vector2( 0, -1 )`` | -+-------------------------------+--------------------------------------------------+----------------------+ ++-------------------------------+--------------------------------------------------+---------------------+ +| :ref:`float` | :ref:`d` | ``0.0`` | ++-------------------------------+--------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`normal` | ``Vector2( 0, 1 )`` | ++-------------------------------+--------------------------------------------------+---------------------+ Property Descriptions --------------------- @@ -50,13 +50,13 @@ The line's distance from the origin. - :ref:`Vector2` **normal** -+-----------+----------------------+ -| *Default* | ``Vector2( 0, -1 )`` | -+-----------+----------------------+ -| *Setter* | set_normal(value) | -+-----------+----------------------+ -| *Getter* | get_normal() | -+-----------+----------------------+ ++-----------+---------------------+ +| *Default* | ``Vector2( 0, 1 )`` | ++-----------+---------------------+ +| *Setter* | set_normal(value) | ++-----------+---------------------+ +| *Getter* | get_normal() | ++-----------+---------------------+ The line's normal. diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 708b54109..df8bce6d4 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -84,6 +84,8 @@ Property Descriptions | *Getter* | get_text() | +-----------+-----------------+ +The button's text that will be displayed inside the button's area. + ---- .. _class_LinkButton_property_underline: @@ -98,3 +100,5 @@ Property Descriptions | *Getter* | get_underline_mode() | +-----------+---------------------------+ +Determines when to show the underline. See :ref:`UnderlineMode` for options. + diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index c594e1ceb..1e3dd4cc6 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -44,9 +44,9 @@ Here is an example script implementing a simple ``MainLoop``: func _input_event(event): # Record keys. if event is InputEventKey and event.pressed and !event.echo: - keys_typed.append(OS.get_scancode_string(event.scancode)) + keys_typed.append(OS.get_keycode_string(event.keycode)) # Quit on Escape press. - if event.scancode == KEY_ESCAPE: + if event.keycode == KEY_ESCAPE: quit = true # Quit on any mouse click. if event is InputEventMouseButton: @@ -60,35 +60,35 @@ Here is an example script implementing a simple ``MainLoop``: Methods ------- -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_finalize` **(** **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_global_menu_action` **(** :ref:`Variant` id, :ref:`Variant` meta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_idle` **(** :ref:`float` delta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_initialize` **(** **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` event **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_text` **(** :ref:`String` text **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | -+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_drop_files` **(** :ref:`PackedStringArray` files, :ref:`int` from_screen **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finalize` **(** **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_global_menu_action` **(** :ref:`Variant` id, :ref:`Variant` meta **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_idle` **(** :ref:`float` delta **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_initialize` **(** **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`idle` **(** :ref:`float` delta **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_event` **(** :ref:`InputEvent` event **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input_text` **(** :ref:`String` text **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -189,7 +189,7 @@ Method Descriptions .. _class_MainLoop_method__drop_files: -- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` from_screen **)** virtual +- void **_drop_files** **(** :ref:`PackedStringArray` files, :ref:`int` from_screen **)** virtual Called when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 76a0d73ac..ac04c6652 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -9,7 +9,7 @@ Marshalls ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Object` Data transformation (marshalling) and encoding helpers. @@ -21,28 +21,28 @@ Provides data transformation and encoding utility functions. Methods ------- -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PackedByteArray` array **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Marshalls_method_base64_to_raw: -- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +- :ref:`PackedByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** -Returns a decoded :ref:`PoolByteArray` corresponding to the Base64-encoded string ``base64_str``. +Returns a decoded :ref:`PackedByteArray` corresponding to the Base64-encoded string ``base64_str``. ---- @@ -66,9 +66,9 @@ Returns a decoded :ref:`Variant` corresponding to the Base64-enco .. _class_Marshalls_method_raw_to_base64: -- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** +- :ref:`String` **raw_to_base64** **(** :ref:`PackedByteArray` array **)** -Returns a Base64-encoded string of a given :ref:`PoolByteArray`. +Returns a Base64-encoded string of a given :ref:`PackedByteArray`. ---- diff --git a/classes/class_material.rst b/classes/class_material.rst index 7812b37c1..3058693fe 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -11,7 +11,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CanvasItemMaterial`, :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial` +**Inherited By:** :ref:`BaseMaterial3D`, :ref:`CanvasItemMaterial`, :ref:`ParticlesMaterial`, :ref:`ShaderMaterial` Abstract base :ref:`Resource` for coloring and shading geometry. @@ -55,7 +55,7 @@ Property Descriptions Sets the ``Material`` to be used for the next pass. This renders the object again using a different material. -**Note:** only applies to :ref:`SpatialMaterial`\ s and :ref:`ShaderMaterial`\ s with type "Spatial". +**Note:** only applies to :ref:`StandardMaterial3D`\ s and :ref:`ShaderMaterial`\ s with type "Spatial". ---- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index f5edc19f0..4af61105e 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -30,29 +30,29 @@ Properties Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_faces` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -65,14 +65,10 @@ Enumerations .. _class_Mesh_constant_PRIMITIVE_LINE_STRIP: -.. _class_Mesh_constant_PRIMITIVE_LINE_LOOP: - .. _class_Mesh_constant_PRIMITIVE_TRIANGLES: .. _class_Mesh_constant_PRIMITIVE_TRIANGLE_STRIP: -.. _class_Mesh_constant_PRIMITIVE_TRIANGLE_FAN: - enum **PrimitiveType**: - **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). @@ -81,13 +77,9 @@ enum **PrimitiveType**: - **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip. -- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed). +- **PRIMITIVE_TRIANGLES** = **3** --- Render array as triangles (every three vertices a triangle is created). -- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). - -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. - -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. +- **PRIMITIVE_TRIANGLE_STRIP** = **4** --- Render array as triangle strips. ---- @@ -125,10 +117,6 @@ enum **BlendShapeMode**: .. _class_Mesh_constant_ARRAY_FORMAT_INDEX: -.. _class_Mesh_constant_ARRAY_COMPRESS_BASE: - -.. _class_Mesh_constant_ARRAY_COMPRESS_VERTEX: - .. _class_Mesh_constant_ARRAY_COMPRESS_NORMAL: .. _class_Mesh_constant_ARRAY_COMPRESS_TANGENT: @@ -139,16 +127,10 @@ enum **BlendShapeMode**: .. _class_Mesh_constant_ARRAY_COMPRESS_TEX_UV2: -.. _class_Mesh_constant_ARRAY_COMPRESS_BONES: - -.. _class_Mesh_constant_ARRAY_COMPRESS_WEIGHTS: - .. _class_Mesh_constant_ARRAY_COMPRESS_INDEX: .. _class_Mesh_constant_ARRAY_FLAG_USE_2D_VERTICES: -.. _class_Mesh_constant_ARRAY_FLAG_USE_16_BIT_BONES: - .. _class_Mesh_constant_ARRAY_COMPRESS_DEFAULT: enum **ArrayFormat**: @@ -171,10 +153,6 @@ enum **ArrayFormat**: - **ARRAY_FORMAT_INDEX** = **256** --- Mesh array uses indices. -- **ARRAY_COMPRESS_BASE** = **9** --- Used internally to calculate other ``ARRAY_COMPRESS_*`` enum values. Do not use. - -- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array. - - **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array. - **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array. @@ -185,17 +163,11 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates. -- **ARRAY_COMPRESS_BONES** = **32768** --- Flag used to mark a compressed bone array. - -- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array. - - **ARRAY_COMPRESS_INDEX** = **131072** --- Flag used to mark a compressed index array. - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices. -- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16-bit bones instead of 8-bit. - -- **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags :ref:`ARRAY_COMPRESS_VERTEX`, :ref:`ARRAY_COMPRESS_NORMAL`, :ref:`ARRAY_COMPRESS_TANGENT`, :ref:`ARRAY_COMPRESS_COLOR`, :ref:`ARRAY_COMPRESS_TEX_UV`, :ref:`ARRAY_COMPRESS_TEX_UV2` and :ref:`ARRAY_COMPRESS_WEIGHTS` quickly. +- **ARRAY_COMPRESS_DEFAULT** = **31744** --- Used to set flags :ref:`ARRAY_COMPRESS_NORMAL`, :ref:`ARRAY_COMPRESS_TANGENT`, :ref:`ARRAY_COMPRESS_COLOR`, :ref:`ARRAY_COMPRESS_TEX_UV` and :ref:`ARRAY_COMPRESS_TEX_UV2` quickly. ---- @@ -258,7 +230,7 @@ Property Descriptions | *Getter* | get_lightmap_size_hint() | +-----------+-------------------------------+ -Sets a hint to be used for lightmap resolution in :ref:`BakedLightmap`. Overrides :ref:`BakedLightmap.bake_default_texels_per_unit`. +Sets a hint to be used for lightmap resolution. Method Descriptions ------------------- @@ -309,7 +281,7 @@ Returns the smallest :ref:`AABB` enclosing this mesh. Not affected b .. _class_Mesh_method_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PackedVector3Array` **get_faces** **(** **)** const Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 14f08c479..336e88e85 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -36,83 +36,83 @@ Below is an example of how MeshDataTool may be used. Methods ------- -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_count` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_count` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_count` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_count` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vertex_count` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PackedInt32Array` bones **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PackedFloat32Array` weights **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -153,7 +153,7 @@ Returns the number of edges in this :ref:`Mesh`. .. _class_MeshDataTool_method_get_edge_faces: -- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const +- :ref:`PackedInt32Array` **get_edge_faces** **(** :ref:`int` idx **)** const Returns array of faces that touch given edge. @@ -249,7 +249,7 @@ Returns the vertex at given index. .. _class_MeshDataTool_method_get_vertex_bones: -- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const +- :ref:`PackedInt32Array` **get_vertex_bones** **(** :ref:`int` idx **)** const Returns the bones of the given vertex. @@ -273,7 +273,7 @@ Returns the total number of vertices in :ref:`Mesh`. .. _class_MeshDataTool_method_get_vertex_edges: -- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const +- :ref:`PackedInt32Array` **get_vertex_edges** **(** :ref:`int` idx **)** const Returns an array of edges that share the given vertex. @@ -281,7 +281,7 @@ Returns an array of edges that share the given vertex. .. _class_MeshDataTool_method_get_vertex_faces: -- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const +- :ref:`PackedInt32Array` **get_vertex_faces** **(** :ref:`int` idx **)** const Returns an array of faces that share the given vertex. @@ -329,7 +329,7 @@ Returns the UV2 of the given vertex. .. _class_MeshDataTool_method_get_vertex_weights: -- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const +- :ref:`PackedFloat32Array` **get_vertex_weights** **(** :ref:`int` idx **)** const Returns bone weights of the given vertex. @@ -369,7 +369,7 @@ Sets the position of the given vertex. .. _class_MeshDataTool_method_set_vertex_bones: -- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** +- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PackedInt32Array` bones **)** Sets the bones of the given vertex. @@ -425,7 +425,7 @@ Sets the UV2 of the given vertex. .. _class_MeshDataTool_method_set_vertex_weights: -- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** +- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PackedFloat32Array` weights **)** Sets the bone weights of the given vertex. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 1aac0e0b5..e28ce589e 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -26,13 +26,13 @@ Tutorials Properties ---------- -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | -+-------------------------------+-------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | -+-------------------------------+-------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-----------------------------------+-------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`normal_map` | ++-----------------------------------+-------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`texture` | ++-----------------------------------+-------------------------------------------------------------+ Signals ------- @@ -62,7 +62,7 @@ The :ref:`Mesh` that will be drawn by the ``MeshInstance2D``. .. _class_MeshInstance2D_property_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture2D` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | @@ -76,7 +76,7 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -84,5 +84,5 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. +The :ref:`Texture2D` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 16b138923..39b41d764 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -21,43 +21,43 @@ A library of meshes. Contains a list of :ref:`Mesh` resources, each Methods ------- -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_item` **(** :ref:`int` id **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_item_navmesh_transform` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` id **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh_transform` **(** :ref:`int` id, :ref:`Transform` navmesh **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_item` **(** :ref:`int` id **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_item_list` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_item_navmesh_transform` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` id **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh_transform` **(** :ref:`int` id, :ref:`Transform` navmesh **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture2D` texture **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -90,7 +90,7 @@ Returns the first item with the given name. .. _class_MeshLibrary_method_get_item_list: -- :ref:`PoolIntArray` **get_item_list** **(** **)** const +- :ref:`PackedInt32Array` **get_item_list** **(** **)** const Returns the list of item IDs in use. @@ -130,11 +130,9 @@ Returns the transform applied to the item's navigation mesh. .. _class_MeshLibrary_method_get_item_preview: -- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const +- :ref:`Texture2D` **get_item_preview** **(** :ref:`int` id **)** const -Returns a generated item preview (a 3D rendering in isometric perspective). - -**Note:** Since item previews are only generated in an editor context, this function will return an empty :ref:`Texture` in a running project. +When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using :ref:`set_item_preview`. Returns an empty :ref:`Texture2D` if no preview was manually set in a running project. ---- @@ -200,7 +198,7 @@ Sets the transform to apply to the item's navigation mesh. .. _class_MeshLibrary_method_set_item_preview: -- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture2D` texture **)** Sets a texture to use as the item's preview icon in the editor. diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 864b6e654..e1b122be2 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -9,7 +9,7 @@ MeshTexture =========== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Simple texture that uses a mesh to draw itself. @@ -21,22 +21,20 @@ Simple texture that uses a mesh to draw itself. It's limited because flags can't Properties ---------- -+-------------------------------+--------------------------------------------------------------+---------------------+ -| :ref:`Texture` | :ref:`base_texture` | | -+-------------------------------+--------------------------------------------------------------+---------------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-------------------------------+--------------------------------------------------------------+---------------------+ -| :ref:`Vector2` | :ref:`image_size` | ``Vector2( 0, 0 )`` | -+-------------------------------+--------------------------------------------------------------+---------------------+ -| :ref:`Mesh` | :ref:`mesh` | | -+-------------------------------+--------------------------------------------------------------+---------------------+ ++-----------------------------------+--------------------------------------------------------------+---------------------+ +| :ref:`Texture2D` | :ref:`base_texture` | | ++-----------------------------------+--------------------------------------------------------------+---------------------+ +| :ref:`Vector2` | :ref:`image_size` | ``Vector2( 0, 0 )`` | ++-----------------------------------+--------------------------------------------------------------+---------------------+ +| :ref:`Mesh` | :ref:`mesh` | | ++-----------------------------------+--------------------------------------------------------------+---------------------+ Property Descriptions --------------------- .. _class_MeshTexture_property_base_texture: -- :ref:`Texture` **base_texture** +- :ref:`Texture2D` **base_texture** +----------+-------------------------+ | *Setter* | set_base_texture(value) | diff --git a/classes/class_monogchandle.rst b/classes/class_monogchandle.rst new file mode 100644 index 000000000..1553d353f --- /dev/null +++ b/classes/class_monogchandle.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the MonoGCHandle.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_MonoGCHandle: + +MonoGCHandle +============ + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + + + diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index cd92b2f3d..721cc4145 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -34,19 +34,29 @@ Tutorials Properties ---------- -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`ColorFormat` | :ref:`color_format` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`CustomDataFormat` | :ref:`custom_data_format` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`instance_count` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`Mesh` | :ref:`mesh` | | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`TransformFormat` | :ref:`transform_format` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`visible_instance_count` | ``-1`` | -+----------------------------------------------------------+--------------------------------------------------------------------------------+--------+ ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedFloat32Array` | :ref:`buffer` | ``PackedFloat32Array( )`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedColorArray` | :ref:`color_array` | | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedColorArray` | :ref:`custom_data_array` | | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`int` | :ref:`instance_count` | ``0`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`Mesh` | :ref:`mesh` | | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`transform_2d_array` | | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector3Array` | :ref:`transform_array` | | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`TransformFormat` | :ref:`transform_format` | ``0`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`use_colors` | ``false`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`use_custom_data` | ``false`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ +| :ref:`int` | :ref:`visible_instance_count` | ``-1`` | ++--------------------------------------------------------+--------------------------------------------------------------------------------+----------------------------+ Methods ------- @@ -62,8 +72,6 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_instance_transform_2d` **(** :ref:`int` instance **)** const | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_bulk_array` **(** :ref:`PoolRealArray` array **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_custom_data` **(** :ref:`int` instance, :ref:`Color` custom_data **)** | @@ -88,74 +96,32 @@ enum **TransformFormat**: - **TRANSFORM_3D** = **1** --- Use this when using 3D transforms. ----- - -.. _enum_MultiMesh_ColorFormat: - -.. _class_MultiMesh_constant_COLOR_NONE: - -.. _class_MultiMesh_constant_COLOR_8BIT: - -.. _class_MultiMesh_constant_COLOR_FLOAT: - -enum **ColorFormat**: - -- **COLOR_NONE** = **0** --- Use when you are not using per-instance :ref:`Color`\ s. - -- **COLOR_8BIT** = **1** --- Compress :ref:`Color` data into 8 bits when passing to shader. This uses less memory and can be faster, but the :ref:`Color` loses precision. - -- **COLOR_FLOAT** = **2** --- The :ref:`Color` passed into :ref:`set_instance_color` will use 4 floats. Use this for highest precision :ref:`Color`. - ----- - -.. _enum_MultiMesh_CustomDataFormat: - -.. _class_MultiMesh_constant_CUSTOM_DATA_NONE: - -.. _class_MultiMesh_constant_CUSTOM_DATA_8BIT: - -.. _class_MultiMesh_constant_CUSTOM_DATA_FLOAT: - -enum **CustomDataFormat**: - -- **CUSTOM_DATA_NONE** = **0** --- Use when you are not using per-instance custom data. - -- **CUSTOM_DATA_8BIT** = **1** --- Compress custom_data into 8 bits when passing to shader. This uses less memory and can be faster, but loses precision and range. Floats packed into 8 bits can only represent values between 0 and 1, numbers outside that range will be clamped. - -- **CUSTOM_DATA_FLOAT** = **2** --- The :ref:`Color` passed into :ref:`set_instance_custom_data` will use 4 floats. Use this for highest precision. - Property Descriptions --------------------- -.. _class_MultiMesh_property_color_format: +.. _class_MultiMesh_property_buffer: -- :ref:`ColorFormat` **color_format** +- :ref:`PackedFloat32Array` **buffer** -+-----------+-------------------------+ -| *Default* | ``0`` | -+-----------+-------------------------+ -| *Setter* | set_color_format(value) | -+-----------+-------------------------+ -| *Getter* | get_color_format() | -+-----------+-------------------------+ - -Format of colors in color array that gets passed to shader. ++-----------+----------------------------+ +| *Default* | ``PackedFloat32Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_buffer(value) | ++-----------+----------------------------+ +| *Getter* | get_buffer() | ++-----------+----------------------------+ ---- -.. _class_MultiMesh_property_custom_data_format: +.. _class_MultiMesh_property_color_array: -- :ref:`CustomDataFormat` **custom_data_format** +- :ref:`PackedColorArray` **color_array** -+-----------+-------------------------------+ -| *Default* | ``0`` | -+-----------+-------------------------------+ -| *Setter* | set_custom_data_format(value) | -+-----------+-------------------------------+ -| *Getter* | get_custom_data_format() | -+-----------+-------------------------------+ +---- -Format of custom data in custom data array that gets passed to shader. +.. _class_MultiMesh_property_custom_data_array: + +- :ref:`PackedColorArray` **custom_data_array** ---- @@ -189,6 +155,18 @@ Mesh to be drawn. ---- +.. _class_MultiMesh_property_transform_2d_array: + +- :ref:`PackedVector2Array` **transform_2d_array** + +---- + +.. _class_MultiMesh_property_transform_array: + +- :ref:`PackedVector3Array` **transform_array** + +---- + .. _class_MultiMesh_property_transform_format: - :ref:`TransformFormat` **transform_format** @@ -205,6 +183,38 @@ Format of transform used to transform mesh, either 2D or 3D. ---- +.. _class_MultiMesh_property_use_colors: + +- :ref:`bool` **use_colors** + ++-----------+-----------------------+ +| *Default* | ``false`` | ++-----------+-----------------------+ +| *Setter* | set_use_colors(value) | ++-----------+-----------------------+ +| *Getter* | is_using_colors() | ++-----------+-----------------------+ + +If ``true``, the ``MultiMesh`` will use color data (see :ref:`color_array`). + +---- + +.. _class_MultiMesh_property_use_custom_data: + +- :ref:`bool` **use_custom_data** + ++-----------+----------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------+ +| *Setter* | set_use_custom_data(value) | ++-----------+----------------------------+ +| *Getter* | is_using_custom_data() | ++-----------+----------------------------+ + +If ``true``, the ``MultiMesh`` will use custom data (see :ref:`custom_data_array`). + +---- + .. _class_MultiMesh_property_visible_instance_count: - :ref:`int` **visible_instance_count** @@ -262,25 +272,13 @@ Returns the :ref:`Transform2D` of a specific instance. ---- -.. _class_MultiMesh_method_set_as_bulk_array: - -- void **set_as_bulk_array** **(** :ref:`PoolRealArray` array **)** - -Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. - -All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc... - -:ref:`Transform` is stored as 12 floats, :ref:`Transform2D` is stored as 8 floats, ``COLOR_8BIT`` / ``CUSTOM_DATA_8BIT`` is stored as 1 float (4 bytes as is) and ``COLOR_FLOAT`` / ``CUSTOM_DATA_FLOAT`` is stored as 4 floats. - ----- - .. _class_MultiMesh_method_set_instance_color: - void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Sets the color of a specific instance. -For the color to take effect, ensure that :ref:`color_format` is non-``null`` on the ``MultiMesh`` and :ref:`SpatialMaterial.vertex_color_use_as_albedo` is ``true`` on the material. +For the color to take effect, ensure that :ref:`use_colors` is ``true`` on the ``MultiMesh`` and :ref:`BaseMaterial3D.vertex_color_use_as_albedo` is ``true`` on the material. ---- @@ -288,7 +286,9 @@ For the color to take effect, ensure that :ref:`color_format` instance, :ref:`Color` custom_data **)** -Sets custom data for a specific instance. Although :ref:`Color` is used, it is just a container for 4 floating point numbers. The format of the number can change depending on the :ref:`CustomDataFormat` used. +Sets custom data for a specific instance. Although :ref:`Color` is used, it is just a container for 4 floating point numbers. + +For the custom data to be used, ensure that :ref:`use_custom_data` is ``true``. ---- diff --git a/classes/class_multimeshinstance2d.rst b/classes/class_multimeshinstance2d.rst index a255e5a8b..250ce15a9 100644 --- a/classes/class_multimeshinstance2d.rst +++ b/classes/class_multimeshinstance2d.rst @@ -26,9 +26,9 @@ Properties +-----------------------------------+------------------------------------------------------------------+ | :ref:`MultiMesh` | :ref:`multimesh` | +-----------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | +| :ref:`Texture2D` | :ref:`normal_map` | +-----------------------------------+------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`texture` | +| :ref:`Texture2D` | :ref:`texture` | +-----------------------------------+------------------------------------------------------------------+ Signals @@ -59,7 +59,7 @@ The :ref:`MultiMesh` that will be drawn by the ``MultiMeshInsta .. _class_MultiMeshInstance2D_property_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture2D` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | @@ -73,7 +73,7 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -81,5 +81,5 @@ The normal map that will be used if using the default :ref:`CanvasItemMaterial` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. +The :ref:`Texture2D` that will be used if using the default :ref:`CanvasItemMaterial`. Can be accessed as ``TEXTURE`` in CanvasItem shader. diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 462fcc1cb..1f536f2fe 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -36,25 +36,25 @@ Properties Methods ------- -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | -+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_network_connected_peers` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -93,7 +93,7 @@ Emitted when this MultiplayerAPI's :ref:`network_peer` id, :ref:`PoolByteArray` packet **)** +- **network_peer_packet** **(** :ref:`int` id, :ref:`PackedByteArray` packet **)** Emitted when this MultiplayerAPI's :ref:`network_peer` receive a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. @@ -118,12 +118,8 @@ Enumerations .. _class_MultiplayerAPI_constant_RPC_MODE_PUPPET: -.. _class_MultiplayerAPI_constant_RPC_MODE_SLAVE: - .. _class_MultiplayerAPI_constant_RPC_MODE_REMOTESYNC: -.. _class_MultiplayerAPI_constant_RPC_MODE_SYNC: - .. _class_MultiplayerAPI_constant_RPC_MODE_MASTERSYNC: .. _class_MultiplayerAPI_constant_RPC_MODE_PUPPETSYNC: @@ -138,12 +134,8 @@ enum **RPCMode**: - **RPC_MODE_PUPPET** = **3** --- Used with :ref:`Node.rpc_config` or :ref:`Node.rset_config` to set a method to be called or a property to be changed only on puppets for this node. Analogous to the ``puppet`` keyword. Only accepts calls or property changes from the node's network master, see :ref:`Node.set_network_master`. -- **RPC_MODE_SLAVE** = **3** --- *Deprecated.* Use :ref:`RPC_MODE_PUPPET` instead. Analogous to the ``slave`` keyword. - - **RPC_MODE_REMOTESYNC** = **4** --- Behave like :ref:`RPC_MODE_REMOTE` but also make the call or property change locally. Analogous to the ``remotesync`` keyword. -- **RPC_MODE_SYNC** = **4** --- *Deprecated.* Use :ref:`RPC_MODE_REMOTESYNC` instead. Analogous to the ``sync`` keyword. - - **RPC_MODE_MASTERSYNC** = **5** --- Behave like :ref:`RPC_MODE_MASTER` but also make the call or property change locally. Analogous to the ``mastersync`` keyword. - **RPC_MODE_PUPPETSYNC** = **6** --- Behave like :ref:`RPC_MODE_PUPPET` but also make the call or property change locally. Analogous to the ``puppetsync`` keyword. @@ -163,7 +155,7 @@ Property Descriptions | *Getter* | is_object_decoding_allowed() | +-----------+----------------------------------+ -If ``true`` (or if the :ref:`network_peer` has :ref:`PacketPeer.allow_object_decoding` set to ``true``), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. +If ``true``, the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. **Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -210,7 +202,7 @@ Clears the current MultiplayerAPI network state (you shouldn't call this unless .. _class_MultiplayerAPI_method_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PackedInt32Array` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. @@ -262,7 +254,7 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if .. _class_MultiplayerAPI_method_send_bytes: -- :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** +- :ref:`Error` **send_bytes** **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index a039d5b6a..9df02bb54 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -29,17 +29,17 @@ Properties Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`StringName` method **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`StringName` path **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`StringName` signal_name **)** const | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`new` **(** ... **)** vararg | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -109,7 +109,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_method_documentation: -- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const +- :ref:`String` **get_method_documentation** **(** :ref:`StringName` method **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. @@ -117,7 +117,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_property_documentation: -- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const +- :ref:`String` **get_property_documentation** **(** :ref:`StringName` path **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. @@ -125,7 +125,7 @@ Returns the documentation string that was previously set with ``godot_nativescri .. _class_NativeScript_method_get_signal_documentation: -- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const +- :ref:`String` **get_signal_documentation** **(** :ref:`StringName` signal_name **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index ca4013630..e949af0d7 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -16,39 +16,67 @@ Mesh-based navigation and pathfinding node. Description ----------- -Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. By default, these will be automatically collected from child :ref:`NavigationMeshInstance` nodes, but they can also be added on the fly with :ref:`navmesh_add`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. +Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. These will be automatically collected from child :ref:`NavigationRegion` nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. Properties ---------- -+-------------------------------+-------------------------------------------------------+------------------------+ -| :ref:`Vector3` | :ref:`up_vector` | ``Vector3( 0, 1, 0 )`` | -+-------------------------------+-------------------------------------------------------+------------------------+ ++-------------------------------+---------------------------------------------------------------------------------+------------------------+ +| :ref:`float` | :ref:`cell_size` | ``0.3`` | ++-------------------------------+---------------------------------------------------------------------------------+------------------------+ +| :ref:`float` | :ref:`edge_connection_margin` | ``5.0`` | ++-------------------------------+---------------------------------------------------------------------------------+------------------------+ +| :ref:`Vector3` | :ref:`up_vector` | ``Vector3( 0, 1, 0 )`` | ++-------------------------------+---------------------------------------------------------------------------------+------------------------+ Methods ------- -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_add` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- +.. _class_Navigation_property_cell_size: + +- :ref:`float` **cell_size** + ++-----------+----------------------+ +| *Default* | ``0.3`` | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ + +---- + +.. _class_Navigation_property_edge_connection_margin: + +- :ref:`float` **edge_connection_margin** + ++-----------+-----------------------------------+ +| *Default* | ``5.0`` | ++-----------+-----------------------------------+ +| *Setter* | set_edge_connection_margin(value) | ++-----------+-----------------------------------+ +| *Getter* | get_edge_connection_margin() | ++-----------+-----------------------------------+ + +---- + .. _class_Navigation_property_up_vector: - :ref:`Vector3` **up_vector** @@ -68,63 +96,45 @@ Method Descriptions .. _class_Navigation_method_get_closest_point: -- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const -Returns the navigation point closest to the point given. Points are in local coordinate space. +Returns the point closest to the provided ``to_point`` on the navigation mesh surface. ---- .. _class_Navigation_method_get_closest_point_normal: -- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** const -Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. +Returns the normal for the point returned by :ref:`get_closest_point`. ---- .. _class_Navigation_method_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** +- :ref:`RID` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** const -Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationMeshInstance`. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner region RID for the point returned by :ref:`get_closest_point`. ---- .. _class_Navigation_method_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** const -Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. +Returns the closest point between the navigation surface and the segment. + +---- + +.. _class_Navigation_method_get_rid: + +- :ref:`RID` **get_rid** **(** **)** const ---- .. _class_Navigation_method_get_simple_path: -- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** +- :ref:`PackedVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** const Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh` (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. ----- - -.. _class_Navigation_method_navmesh_add: - -- :ref:`int` **navmesh_add** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** - -Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. - ----- - -.. _class_Navigation_method_navmesh_remove: - -- void **navmesh_remove** **(** :ref:`int` id **)** - -Removes the :ref:`NavigationMesh` with the given ID. - ----- - -.. _class_Navigation_method_navmesh_set_transform: - -- void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** - -Sets the transform applied to the :ref:`NavigationMesh` with the given ID. - diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index fb4c213b0..28375ecf6 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -16,71 +16,87 @@ Navigation2D Description ----------- -Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. By default, these are automatically collected from child :ref:`NavigationPolygonInstance` nodes, but they can also be added on the fly with :ref:`navpoly_add`. +Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. These are automatically collected from child :ref:`NavigationRegion2D` nodes. + +Properties +---------- + ++---------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`cell_size` | ``10.0`` | ++---------------------------+-----------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`edge_connection_margin` | ``100.0`` | ++---------------------------+-----------------------------------------------------------------------------------+-----------+ Methods ------- -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_add` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | -+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_Navigation2D_property_cell_size: + +- :ref:`float` **cell_size** + ++-----------+----------------------+ +| *Default* | ``10.0`` | ++-----------+----------------------+ +| *Setter* | set_cell_size(value) | ++-----------+----------------------+ +| *Getter* | get_cell_size() | ++-----------+----------------------+ + +---- + +.. _class_Navigation2D_property_edge_connection_margin: + +- :ref:`float` **edge_connection_margin** + ++-----------+-----------------------------------+ +| *Default* | ``100.0`` | ++-----------+-----------------------------------+ +| *Setter* | set_edge_connection_margin(value) | ++-----------+-----------------------------------+ +| *Getter* | get_edge_connection_margin() | ++-----------+-----------------------------------+ Method Descriptions ------------------- .. _class_Navigation2D_method_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const -Returns the navigation point closest to the point given. Points are in local coordinate space. +Returns the point closest to the provided ``to_point`` on the navigation mesh surface. ---- .. _class_Navigation2D_method_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** +- :ref:`RID` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** const -Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationPolygonInstance`. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner region RID for the point returned by :ref:`get_closest_point`. + +---- + +.. _class_Navigation2D_method_get_rid: + +- :ref:`RID` **get_rid** **(** **)** const ---- .. _class_Navigation2D_method_get_simple_path: -- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** +- :ref:`PackedVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** const Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the path is smoothed by merging path segments where possible. ----- - -.. _class_Navigation2D_method_navpoly_add: - -- :ref:`int` **navpoly_add** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** - -Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. - ----- - -.. _class_Navigation2D_method_navpoly_remove: - -- void **navpoly_remove** **(** :ref:`int` id **)** - -Removes the :ref:`NavigationPolygon` with the given ID. - ----- - -.. _class_Navigation2D_method_navpoly_set_transform: - -- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** - -Sets the transform applied to the :ref:`NavigationPolygon` with the given ID. - diff --git a/classes/class_navigation2dserver.rst b/classes/class_navigation2dserver.rst new file mode 100644 index 000000000..ca9c347ac --- /dev/null +++ b/classes/class_navigation2dserver.rst @@ -0,0 +1,296 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Navigation2DServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Navigation2DServer: + +Navigation2DServer +================== + +**Inherits:** :ref:`Object` + +Server interface for low-level 2D navigation access + +Description +----------- + +Navigation2DServer is the server responsible for all 2D navigation. It creates the agents, maps, and regions for navigation to work as expected. This keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. + +Methods +------- + ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_create` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector2` position **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector2` target_velocity **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** :ref:`RID` object **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_create` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector2` to_point **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_create` **(** **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navpoly` **(** :ref:`RID` region, :ref:`NavigationPolygon` nav_poly **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform2D` transform **)** const | ++-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Navigation2DServer_method_agent_create: + +- :ref:`RID` **agent_create** **(** **)** const + +Creates the agent. + +---- + +.. _class_Navigation2DServer_method_agent_is_map_changed: + +- :ref:`bool` **agent_is_map_changed** **(** :ref:`RID` agent **)** const + +Returns true if the map got changed the previous frame. + +---- + +.. _class_Navigation2DServer_method_agent_set_callback: + +- void **agent_set_callback** **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** const + +Callback called at the end of the RVO process. + +---- + +.. _class_Navigation2DServer_method_agent_set_map: + +- void **agent_set_map** **(** :ref:`RID` agent, :ref:`RID` map **)** const + +Puts the agent in the map. + +---- + +.. _class_Navigation2DServer_method_agent_set_max_neighbors: + +- void **agent_set_max_neighbors** **(** :ref:`RID` agent, :ref:`int` count **)** const + +Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. + +---- + +.. _class_Navigation2DServer_method_agent_set_max_speed: + +- void **agent_set_max_speed** **(** :ref:`RID` agent, :ref:`float` max_speed **)** const + +Sets the maximum speed of the agent. Must be positive. + +---- + +.. _class_Navigation2DServer_method_agent_set_neighbor_dist: + +- void **agent_set_neighbor_dist** **(** :ref:`RID` agent, :ref:`float` dist **)** const + +Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. + +---- + +.. _class_Navigation2DServer_method_agent_set_position: + +- void **agent_set_position** **(** :ref:`RID` agent, :ref:`Vector2` position **)** const + +Sets the position of the agent in world space. + +---- + +.. _class_Navigation2DServer_method_agent_set_radius: + +- void **agent_set_radius** **(** :ref:`RID` agent, :ref:`float` radius **)** const + +Sets the radius of the agent. + +---- + +.. _class_Navigation2DServer_method_agent_set_target_velocity: + +- void **agent_set_target_velocity** **(** :ref:`RID` agent, :ref:`Vector2` target_velocity **)** const + +Sets the new target velocity. + +---- + +.. _class_Navigation2DServer_method_agent_set_time_horizon: + +- void **agent_set_time_horizon** **(** :ref:`RID` agent, :ref:`float` time **)** const + +The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. + +---- + +.. _class_Navigation2DServer_method_agent_set_velocity: + +- void **agent_set_velocity** **(** :ref:`RID` agent, :ref:`Vector2` velocity **)** const + +Sets the current velocity of the agent. + +---- + +.. _class_Navigation2DServer_method_free: + +- void **free** **(** :ref:`RID` object **)** const + +Destroy the RID + +---- + +.. _class_Navigation2DServer_method_map_create: + +- :ref:`RID` **map_create** **(** **)** const + +Create a new map. + +---- + +.. _class_Navigation2DServer_method_map_get_cell_size: + +- :ref:`float` **map_get_cell_size** **(** :ref:`RID` map **)** const + +Returns the map cell size. + +---- + +.. _class_Navigation2DServer_method_map_get_closest_point: + +- :ref:`Vector2` **map_get_closest_point** **(** :ref:`RID` map, :ref:`Vector2` to_point **)** const + +Returns the point closest to the provided ``to_point`` on the navigation mesh surface. + +---- + +.. _class_Navigation2DServer_method_map_get_closest_point_owner: + +- :ref:`RID` **map_get_closest_point_owner** **(** :ref:`RID` map, :ref:`Vector2` to_point **)** const + +Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. + +---- + +.. _class_Navigation2DServer_method_map_get_edge_connection_margin: + +- :ref:`float` **map_get_edge_connection_margin** **(** :ref:`RID` map **)** const + +Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions. + +---- + +.. _class_Navigation2DServer_method_map_get_path: + +- :ref:`PackedVector2Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize **)** const + +Returns the navigation path to reach the destination from the origin, while avoiding static obstacles. + +---- + +.. _class_Navigation2DServer_method_map_is_active: + +- :ref:`bool` **map_is_active** **(** :ref:`RID` nap **)** const + +Returns true if the map is active. + +---- + +.. _class_Navigation2DServer_method_map_set_active: + +- void **map_set_active** **(** :ref:`RID` map, :ref:`bool` active **)** const + +Sets the map active. + +---- + +.. _class_Navigation2DServer_method_map_set_cell_size: + +- void **map_set_cell_size** **(** :ref:`RID` map, :ref:`float` cell_size **)** const + +Set the map cell size used to weld the navigation mesh polygons. + +---- + +.. _class_Navigation2DServer_method_map_set_edge_connection_margin: + +- void **map_set_edge_connection_margin** **(** :ref:`RID` map, :ref:`float` margin **)** const + +Set the map edge connection margin used to weld the compatible region edges. + +---- + +.. _class_Navigation2DServer_method_region_create: + +- :ref:`RID` **region_create** **(** **)** const + +Creates a new region. + +---- + +.. _class_Navigation2DServer_method_region_set_map: + +- void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** const + +Sets the map for the region. + +---- + +.. _class_Navigation2DServer_method_region_set_navpoly: + +- void **region_set_navpoly** **(** :ref:`RID` region, :ref:`NavigationPolygon` nav_poly **)** const + +Sets the navigation mesh for the region. + +---- + +.. _class_Navigation2DServer_method_region_set_transform: + +- void **region_set_transform** **(** :ref:`RID` region, :ref:`Transform2D` transform **)** const + +Sets the global transformation for the region. + diff --git a/classes/class_navigationagent.rst b/classes/class_navigationagent.rst new file mode 100644 index 000000000..4bc7614fd --- /dev/null +++ b/classes/class_navigationagent.rst @@ -0,0 +1,357 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationAgent.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationAgent: + +NavigationAgent +=============== + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +3D Agent used in navigation for collision avoidance. + +Description +----------- + +3D Agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. This can be done by having the agent as a child of a :ref:`Navigation` node, or using :ref:`set_navigation`. ``NavigationAgent`` is physics safe. + +Properties +---------- + ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`agent_height_offset` | ``0.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`ignore_y` | ``true`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`max_neighbors` | ``10`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`max_speed` | ``10.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`neighbor_dist` | ``50.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`path_max_distance` | ``3.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`radius` | ``1.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`target_desired_distance` | ``1.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`time_horizon` | ``5.0`` | ++---------------------------+----------------------------------------------------------------------------------------+----------+ + +Methods +------- + ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to_target` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_final_location` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_nav_path` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_nav_path_index` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_navigation` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_next_location` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_target_location` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_navigation_finished` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_target_reachable` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_target_reached` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_location` **(** :ref:`Vector3` location **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_velocity` **(** :ref:`Vector3` velocity **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_NavigationAgent_signal_navigation_finished: + +- **navigation_finished** **(** **)** + +Notifies when the final location is reached. + +---- + +.. _class_NavigationAgent_signal_path_changed: + +- **path_changed** **(** **)** + +Notifies when the navigation path changes. + +---- + +.. _class_NavigationAgent_signal_target_reached: + +- **target_reached** **(** **)** + +Notifies when the player defined target, set with :ref:`set_target_location`, is reached. + +---- + +.. _class_NavigationAgent_signal_velocity_computed: + +- **velocity_computed** **(** :ref:`Vector3` safe_velocity **)** + +Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. + +Property Descriptions +--------------------- + +.. _class_NavigationAgent_property_agent_height_offset: + +- :ref:`float` **agent_height_offset** + ++-----------+--------------------------------+ +| *Default* | ``0.0`` | ++-----------+--------------------------------+ +| *Setter* | set_agent_height_offset(value) | ++-----------+--------------------------------+ +| *Getter* | get_agent_height_offset() | ++-----------+--------------------------------+ + +The agent height offset to match the navigation mesh height. + +---- + +.. _class_NavigationAgent_property_ignore_y: + +- :ref:`bool` **ignore_y** + ++-----------+---------------------+ +| *Default* | ``true`` | ++-----------+---------------------+ +| *Setter* | set_ignore_y(value) | ++-----------+---------------------+ +| *Getter* | get_ignore_y() | ++-----------+---------------------+ + +Ignores collisions on the Y axis. Must be true to move on a horizontal plane. + +---- + +.. _class_NavigationAgent_property_max_neighbors: + +- :ref:`int` **max_neighbors** + ++-----------+--------------------------+ +| *Default* | ``10`` | ++-----------+--------------------------+ +| *Setter* | set_max_neighbors(value) | ++-----------+--------------------------+ +| *Getter* | get_max_neighbors() | ++-----------+--------------------------+ + +The maximum number of neighbors for the agent to consider. + +---- + +.. _class_NavigationAgent_property_max_speed: + +- :ref:`float` **max_speed** + ++-----------+----------------------+ +| *Default* | ``10.0`` | ++-----------+----------------------+ +| *Setter* | set_max_speed(value) | ++-----------+----------------------+ +| *Getter* | get_max_speed() | ++-----------+----------------------+ + +The maximum speed that an agent can move. + +---- + +.. _class_NavigationAgent_property_neighbor_dist: + +- :ref:`float` **neighbor_dist** + ++-----------+--------------------------+ +| *Default* | ``50.0`` | ++-----------+--------------------------+ +| *Setter* | set_neighbor_dist(value) | ++-----------+--------------------------+ +| *Getter* | get_neighbor_dist() | ++-----------+--------------------------+ + +The distance to search for other agents. + +---- + +.. _class_NavigationAgent_property_path_max_distance: + +- :ref:`float` **path_max_distance** + ++-----------+------------------------------+ +| *Default* | ``3.0`` | ++-----------+------------------------------+ +| *Setter* | set_path_max_distance(value) | ++-----------+------------------------------+ +| *Getter* | get_path_max_distance() | ++-----------+------------------------------+ + +The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. + +---- + +.. _class_NavigationAgent_property_radius: + +- :ref:`float` **radius** + ++-----------+-------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ + +The radius of the agent. + +---- + +.. _class_NavigationAgent_property_target_desired_distance: + +- :ref:`float` **target_desired_distance** + ++-----------+------------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------------+ +| *Setter* | set_target_desired_distance(value) | ++-----------+------------------------------------+ +| *Getter* | get_target_desired_distance() | ++-----------+------------------------------------+ + +The distance threshold before a target is considered to be reached. This will allow an agent to not have to hit a point on the path exactly, but in the area. + +---- + +.. _class_NavigationAgent_property_time_horizon: + +- :ref:`float` **time_horizon** + ++-----------+-------------------------+ +| *Default* | ``5.0`` | ++-----------+-------------------------+ +| *Setter* | set_time_horizon(value) | ++-----------+-------------------------+ +| *Getter* | get_time_horizon() | ++-----------+-------------------------+ + +The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive. + +Method Descriptions +------------------- + +.. _class_NavigationAgent_method_distance_to_target: + +- :ref:`float` **distance_to_target** **(** **)** const + +Returns the distance to the target location, using the agent's global position. The user must set the target location with :ref:`set_target_location` in order for this to be accurate. + +---- + +.. _class_NavigationAgent_method_get_final_location: + +- :ref:`Vector3` **get_final_location** **(** **)** + +Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame. + +---- + +.. _class_NavigationAgent_method_get_nav_path: + +- :ref:`PackedVector3Array` **get_nav_path** **(** **)** const + +Returns the path from start to finish in global coordinates. + +---- + +.. _class_NavigationAgent_method_get_nav_path_index: + +- :ref:`int` **get_nav_path_index** **(** **)** const + +Returns which index the agent is currently on in the navigation path's :ref:`PackedVector3Array`. + +---- + +.. _class_NavigationAgent_method_get_navigation: + +- :ref:`Node` **get_navigation** **(** **)** const + +Returns the :ref:`Navigation` node that the agent is using for its navigation system. + +---- + +.. _class_NavigationAgent_method_get_next_location: + +- :ref:`Vector3` **get_next_location** **(** **)** + +Returns a :ref:`Vector3` in global coordinates, that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the origin of the agent's parent. + +---- + +.. _class_NavigationAgent_method_get_target_location: + +- :ref:`Vector3` **get_target_location** **(** **)** const + +Returns the user defined :ref:`Vector3` after setting the target location. + +---- + +.. _class_NavigationAgent_method_is_navigation_finished: + +- :ref:`bool` **is_navigation_finished** **(** **)** + +Returns true if the navigation path's final location has been reached. + +---- + +.. _class_NavigationAgent_method_is_target_reachable: + +- :ref:`bool` **is_target_reachable** **(** **)** + +Returns true if the target location is reachable. The target location is set using :ref:`set_target_location`. + +---- + +.. _class_NavigationAgent_method_is_target_reached: + +- :ref:`bool` **is_target_reached** **(** **)** const + +Returns true if the target location is reached. The target location is set using :ref:`set_target_location`. It may not always be possible to reach the target location. It should always be possible to reach the final location though. See :ref:`get_final_location`. + +---- + +.. _class_NavigationAgent_method_set_navigation: + +- void **set_navigation** **(** :ref:`Node` navigation **)** + +Sets the :ref:`Navigation` node used by the agent. Useful when you don't want to make the agent a child of a :ref:`Navigation` node. + +---- + +.. _class_NavigationAgent_method_set_target_location: + +- void **set_target_location** **(** :ref:`Vector3` location **)** + +Sets the user desired final location. This will clear the current navigation path. + +---- + +.. _class_NavigationAgent_method_set_velocity: + +- void **set_velocity** **(** :ref:`Vector3` velocity **)** + +Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the :ref:`velocity_computed` signal. + diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst new file mode 100644 index 000000000..1ac1f8f73 --- /dev/null +++ b/classes/class_navigationagent2d.rst @@ -0,0 +1,321 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationAgent2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationAgent2D: + +NavigationAgent2D +================= + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +2D Agent used in navigation for collision avoidance. + +Description +----------- + +2D Agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. This can be done by having the agent as a child of a :ref:`Navigation2D` node, or using :ref:`set_navigation`. ``NavigationAgent2D`` is physics safe. + +Properties +---------- + ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`max_neighbors` | ``10`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`max_speed` | ``200.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`neighbor_dist` | ``500.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`path_max_distance` | ``3.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`radius` | ``10.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`target_desired_distance` | ``1.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`time_horizon` | ``20.0`` | ++---------------------------+------------------------------------------------------------------------------------------+-----------+ + +Methods +------- + ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`distance_to_target` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_final_location` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_nav_path` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_nav_path_index` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_navigation` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_next_location` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_target_location` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_navigation_finished` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_target_reachable` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_target_reached` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_target_location` **(** :ref:`Vector2` location **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_velocity` **(** :ref:`Vector2` velocity **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_NavigationAgent2D_signal_navigation_finished: + +- **navigation_finished** **(** **)** + +Notifies when the final location is reached. + +---- + +.. _class_NavigationAgent2D_signal_path_changed: + +- **path_changed** **(** **)** + +Notifies when the navigation path changes. + +---- + +.. _class_NavigationAgent2D_signal_target_reached: + +- **target_reached** **(** **)** + +Notifies when the player defined target, set with :ref:`set_target_location`, is reached. + +---- + +.. _class_NavigationAgent2D_signal_velocity_computed: + +- **velocity_computed** **(** :ref:`Vector3` safe_velocity **)** + +Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. + +Property Descriptions +--------------------- + +.. _class_NavigationAgent2D_property_max_neighbors: + +- :ref:`int` **max_neighbors** + ++-----------+--------------------------+ +| *Default* | ``10`` | ++-----------+--------------------------+ +| *Setter* | set_max_neighbors(value) | ++-----------+--------------------------+ +| *Getter* | get_max_neighbors() | ++-----------+--------------------------+ + +The maximum number of neighbors for the agent to consider. + +---- + +.. _class_NavigationAgent2D_property_max_speed: + +- :ref:`float` **max_speed** + ++-----------+----------------------+ +| *Default* | ``200.0`` | ++-----------+----------------------+ +| *Setter* | set_max_speed(value) | ++-----------+----------------------+ +| *Getter* | get_max_speed() | ++-----------+----------------------+ + +The maximum speed that an agent can move. + +---- + +.. _class_NavigationAgent2D_property_neighbor_dist: + +- :ref:`float` **neighbor_dist** + ++-----------+--------------------------+ +| *Default* | ``500.0`` | ++-----------+--------------------------+ +| *Setter* | set_neighbor_dist(value) | ++-----------+--------------------------+ +| *Getter* | get_neighbor_dist() | ++-----------+--------------------------+ + +The distance to search for other agents. + +---- + +.. _class_NavigationAgent2D_property_path_max_distance: + +- :ref:`float` **path_max_distance** + ++-----------+------------------------------+ +| *Default* | ``3.0`` | ++-----------+------------------------------+ +| *Setter* | set_path_max_distance(value) | ++-----------+------------------------------+ +| *Getter* | get_path_max_distance() | ++-----------+------------------------------+ + +The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. + +---- + +.. _class_NavigationAgent2D_property_radius: + +- :ref:`float` **radius** + ++-----------+-------------------+ +| *Default* | ``10.0`` | ++-----------+-------------------+ +| *Setter* | set_radius(value) | ++-----------+-------------------+ +| *Getter* | get_radius() | ++-----------+-------------------+ + +The radius of the agent. + +---- + +.. _class_NavigationAgent2D_property_target_desired_distance: + +- :ref:`float` **target_desired_distance** + ++-----------+------------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------------+ +| *Setter* | set_target_desired_distance(value) | ++-----------+------------------------------------+ +| *Getter* | get_target_desired_distance() | ++-----------+------------------------------------+ + +The distance threshold before a target is considered to be reached. This will allow an agent to not have to hit a point on the path exactly, but in the area. + +---- + +.. _class_NavigationAgent2D_property_time_horizon: + +- :ref:`float` **time_horizon** + ++-----------+-------------------------+ +| *Default* | ``20.0`` | ++-----------+-------------------------+ +| *Setter* | set_time_horizon(value) | ++-----------+-------------------------+ +| *Getter* | get_time_horizon() | ++-----------+-------------------------+ + +The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive. + +Method Descriptions +------------------- + +.. _class_NavigationAgent2D_method_distance_to_target: + +- :ref:`float` **distance_to_target** **(** **)** const + +Returns the distance to the target location, using the agent's global position. The user must set the target location with :ref:`set_target_location` in order for this to be accurate. + +---- + +.. _class_NavigationAgent2D_method_get_final_location: + +- :ref:`Vector2` **get_final_location** **(** **)** + +Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. + +---- + +.. _class_NavigationAgent2D_method_get_nav_path: + +- :ref:`PackedVector2Array` **get_nav_path** **(** **)** const + +Returns the path from start to finish in global coordinates. + +---- + +.. _class_NavigationAgent2D_method_get_nav_path_index: + +- :ref:`int` **get_nav_path_index** **(** **)** const + +Returns which index the agent is currently on in the navigation path's :ref:`PackedVector2Array`. + +---- + +.. _class_NavigationAgent2D_method_get_navigation: + +- :ref:`Node` **get_navigation** **(** **)** const + +Returns the :ref:`Navigation2D` node that the agent is using for its navigation system. + +---- + +.. _class_NavigationAgent2D_method_get_next_location: + +- :ref:`Vector2` **get_next_location** **(** **)** + +Returns a :ref:`Vector2` in global coordinates, that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. + +---- + +.. _class_NavigationAgent2D_method_get_target_location: + +- :ref:`Vector2` **get_target_location** **(** **)** const + +Returns the user defined :ref:`Vector2` after setting the target location. + +---- + +.. _class_NavigationAgent2D_method_is_navigation_finished: + +- :ref:`bool` **is_navigation_finished** **(** **)** + +Returns true if the navigation path's final location has been reached. + +---- + +.. _class_NavigationAgent2D_method_is_target_reachable: + +- :ref:`bool` **is_target_reachable** **(** **)** + +Returns true if the target location is reachable. The target location is set using :ref:`set_target_location`. + +---- + +.. _class_NavigationAgent2D_method_is_target_reached: + +- :ref:`bool` **is_target_reached** **(** **)** const + +Returns true if the target location is reached. The target location is set using :ref:`set_target_location`. It may not always be possible to reach the target location. It should always be possible to reach the final location though. See :ref:`get_final_location`. + +---- + +.. _class_NavigationAgent2D_method_set_navigation: + +- void **set_navigation** **(** :ref:`Node` navigation **)** + +Sets the :ref:`Navigation2D` node used by the agent. Useful when you don't want to make the agent a child of a :ref:`Navigation2D` node. + +---- + +.. _class_NavigationAgent2D_method_set_target_location: + +- void **set_target_location** **(** :ref:`Vector2` location **)** + +Sets the user desired final location. This will clear the current navigation path. + +---- + +.. _class_NavigationAgent2D_method_set_velocity: + +- void **set_velocity** **(** :ref:`Vector2` velocity **)** + +Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the :ref:`velocity_computed` signal. + diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index d79404f92..fcc1c2061 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -16,72 +16,72 @@ NavigationMesh Properties ---------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/height` | ``2.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/max_climb` | ``0.9`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/max_slope` | ``45.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`agent/radius` | ``0.6`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`cell/height` | ``0.2`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`cell/size` | ``0.3`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`detail/sample_distance` | ``6.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`detail/sample_max_error` | ``1.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`edge/max_error` | ``1.3`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`edge/max_length` | ``12.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | ``false`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/ledge_spans` | ``false`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | ``false`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`geometry/collision_mask` | | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`geometry/parsed_geometry_type` | ``0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`geometry/source_geometry_mode` | ``0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`geometry/source_group_name` | | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`polygon/verts_per_poly` | ``6.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`region/merge_size` | ``20.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`region/min_size` | ``8.0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | ``0`` | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`agent/height` | ``2.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`agent/max_climb` | ``0.9`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`agent/max_slope` | ``45.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`agent/radius` | ``0.6`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`cell/height` | ``0.2`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`cell/size` | ``0.3`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`detail/sample_distance` | ``6.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`detail/sample_max_error` | ``1.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`edge/max_error` | ``1.3`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`edge/max_length` | ``12.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`filter/filter_walkable_low_height_spans` | ``false`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`filter/ledge_spans` | ``false`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`filter/low_hanging_obstacles` | ``false`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`geometry/collision_mask` | | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`geometry/parsed_geometry_type` | ``0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`geometry/source_geometry_mode` | ``0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`StringName` | :ref:`geometry/source_group_name` | | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`polygon/verts_per_poly` | ``6.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`region/merge_size` | ``20.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`region/min_size` | ``8.0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`sample_partition_type/sample_partition_type` | ``0`` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+-----------+ Methods ------- -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PackedInt32Array` polygon **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`get_vertices` **(** **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PackedVector3Array` vertices **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants --------- @@ -337,7 +337,7 @@ Property Descriptions .. _class_NavigationMesh_property_geometry/source_group_name: -- :ref:`String` **geometry/source_group_name** +- :ref:`StringName` **geometry/source_group_name** +----------+------------------------------+ | *Setter* | set_source_group_name(value) | @@ -406,7 +406,7 @@ Method Descriptions .. _class_NavigationMesh_method_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PackedInt32Array` polygon **)** ---- @@ -430,7 +430,7 @@ Method Descriptions .. _class_NavigationMesh_method_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PackedInt32Array` **get_polygon** **(** :ref:`int` idx **)** ---- @@ -442,7 +442,7 @@ Method Descriptions .. _class_NavigationMesh_method_get_vertices: -- :ref:`PoolVector3Array` **get_vertices** **(** **)** const +- :ref:`PackedVector3Array` **get_vertices** **(** **)** const ---- @@ -454,5 +454,5 @@ Method Descriptions .. _class_NavigationMesh_method_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** +- void **set_vertices** **(** :ref:`PackedVector3Array` vertices **)** diff --git a/classes/class_editornavigationmeshgenerator.rst b/classes/class_navigationmeshgenerator.rst similarity index 52% rename from classes/class_editornavigationmeshgenerator.rst rename to classes/class_navigationmeshgenerator.rst index de28b01ce..7b22e5ff5 100644 --- a/classes/class_editornavigationmeshgenerator.rst +++ b/classes/class_navigationmeshgenerator.rst @@ -1,13 +1,13 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the EditorNavigationMeshGenerator.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationMeshGenerator.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_EditorNavigationMeshGenerator: +.. _class_NavigationMeshGenerator: -EditorNavigationMeshGenerator -============================= +NavigationMeshGenerator +======================= **Inherits:** :ref:`Object` @@ -16,22 +16,22 @@ EditorNavigationMeshGenerator Methods ------- -+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** | -+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`NavigationMesh` nav_mesh **)** | -+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`NavigationMesh` nav_mesh **)** | ++------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_EditorNavigationMeshGenerator_method_bake: +.. _class_NavigationMeshGenerator_method_bake: - void **bake** **(** :ref:`NavigationMesh` nav_mesh, :ref:`Node` root_node **)** ---- -.. _class_EditorNavigationMeshGenerator_method_clear: +.. _class_NavigationMeshGenerator_method_clear: - void **clear** **(** :ref:`NavigationMesh` nav_mesh **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst deleted file mode 100644 index f889fea10..000000000 --- a/classes/class_navigationmeshinstance.rst +++ /dev/null @@ -1,51 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the NavigationMeshInstance.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_NavigationMeshInstance: - -NavigationMeshInstance -====================== - -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - - - -Properties ----------- - -+---------------------------------------------+---------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`enabled` | ``true`` | -+---------------------------------------------+---------------------------------------------------------------+----------+ -| :ref:`NavigationMesh` | :ref:`navmesh` | | -+---------------------------------------------+---------------------------------------------------------------+----------+ - -Property Descriptions ---------------------- - -.. _class_NavigationMeshInstance_property_enabled: - -- :ref:`bool` **enabled** - -+-----------+--------------------+ -| *Default* | ``true`` | -+-----------+--------------------+ -| *Setter* | set_enabled(value) | -+-----------+--------------------+ -| *Getter* | is_enabled() | -+-----------+--------------------+ - ----- - -.. _class_NavigationMeshInstance_property_navmesh: - -- :ref:`NavigationMesh` **navmesh** - -+----------+----------------------------+ -| *Setter* | set_navigation_mesh(value) | -+----------+----------------------------+ -| *Getter* | get_navigation_mesh() | -+----------+----------------------------+ - diff --git a/classes/class_navigationobstacle.rst b/classes/class_navigationobstacle.rst new file mode 100644 index 000000000..ffacf8dff --- /dev/null +++ b/classes/class_navigationobstacle.rst @@ -0,0 +1,46 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationObstacle.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationObstacle: + +NavigationObstacle +================== + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +3D Obstacle used in navigation for collision avoidance. + +Description +----------- + +3D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a :ref:`Navigation` node, or using :ref:`set_navigation`. ``NavigationObstacle`` is physics safe. + +Methods +------- + ++-------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_navigation` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_NavigationObstacle_method_get_navigation: + +- :ref:`Node` **get_navigation** **(** **)** const + +Returns the :ref:`Navigation` node that the obstacle is using for its navigation system. + +---- + +.. _class_NavigationObstacle_method_set_navigation: + +- void **set_navigation** **(** :ref:`Node` navigation **)** + +Sets the :ref:`Navigation` node used by the obstacle. Useful when you don't want to make the obstacle a child of a :ref:`Navigation` node. + diff --git a/classes/class_navigationobstacle2d.rst b/classes/class_navigationobstacle2d.rst new file mode 100644 index 000000000..662029925 --- /dev/null +++ b/classes/class_navigationobstacle2d.rst @@ -0,0 +1,46 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationObstacle2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationObstacle2D: + +NavigationObstacle2D +==================== + +**Inherits:** :ref:`Node` **<** :ref:`Object` + +2D Obstacle used in navigation for collision avoidance. + +Description +----------- + +2D Obstacle used in navigation for collision avoidance. The obstacle needs navigation data to work correctly. This can be done by having the obstacle as a child of a :ref:`Navigation2D` node, or using :ref:`set_navigation`. :ref:`NavigationObstacle` is physics safe. + +Methods +------- + ++-------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_navigation` **(** **)** const | ++-------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation` **(** :ref:`Node` navigation **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_NavigationObstacle2D_method_get_navigation: + +- :ref:`Node` **get_navigation** **(** **)** const + +Returns the :ref:`Navigation2D` node that the obstacle is using for its navigation system. + +---- + +.. _class_NavigationObstacle2D_method_set_navigation: + +- void **set_navigation** **(** :ref:`Node` navigation **)** + +Sets the :ref:`Navigation2D` node used by the obstacle. Useful when you don't want to make the obstacle a child of a :ref:`Navigation2D` node. + diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index 4469356b7..f4ffadc52 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -23,77 +23,77 @@ Using :ref:`add_outline`: :: var polygon = NavigationPolygon.new() - var outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.add_outline(outline) polygon.make_polygons_from_outlines() - $NavigationPolygonInstance.navpoly = polygon + $NavigationRegion2D.navpoly = polygon Using :ref:`add_polygon` and indices of the vertices array. :: var polygon = NavigationPolygon.new() - var vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) + var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.set_vertices(vertices) - var indices = PoolIntArray(0, 3, 1) + var indices = PackedInt32Array(0, 3, 1) polygon.add_polygon(indices) - $NavigationPolygonInstance.navpoly = polygon + $NavigationRegion2D.navpoly = polygon Methods ------- -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_outlines` **(** **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_outline_count` **(** **)** const | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_polygons_from_outlines` **(** **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | -+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline` **(** :ref:`PackedVector2Array` outline **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_outline_at_index` **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PackedInt32Array` polygon **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_outlines` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_outline_count` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_vertices` **(** **)** const | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_polygons_from_outlines` **(** **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_outline` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PackedVector2Array` vertices **)** | ++-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_NavigationPolygon_method_add_outline: -- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** +- void **add_outline** **(** :ref:`PackedVector2Array` outline **)** -Appends a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Appends a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. ---- .. _class_NavigationPolygon_method_add_outline_at_index: -- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** +- void **add_outline_at_index** **(** :ref:`PackedVector2Array` outline, :ref:`int` index **)** -Adds a :ref:`PoolVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. +Adds a :ref:`PackedVector2Array` that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call :ref:`make_polygons_from_outlines` in order for this array to be converted to polygons that the engine will use. ---- .. _class_NavigationPolygon_method_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PackedInt32Array` polygon **)** Adds a polygon using the indices of the vertices you get when calling :ref:`get_vertices`. @@ -117,9 +117,9 @@ Clears the array of polygons, but it doesn't clear the array of outlines and ver .. _class_NavigationPolygon_method_get_outline: -- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const +- :ref:`PackedVector2Array` **get_outline** **(** :ref:`int` idx **)** const -Returns a :ref:`PoolVector2Array` containing the vertices of an outline that was created in the editor or by script. +Returns a :ref:`PackedVector2Array` containing the vertices of an outline that was created in the editor or by script. ---- @@ -133,9 +133,9 @@ Returns the number of outlines that were created in the editor or by script. .. _class_NavigationPolygon_method_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PackedInt32Array` **get_polygon** **(** :ref:`int` idx **)** -Returns a :ref:`PoolIntArray` containing the indices of the vertices of a created polygon. +Returns a :ref:`PackedInt32Array` containing the indices of the vertices of a created polygon. ---- @@ -149,9 +149,9 @@ Returns the count of all polygons. .. _class_NavigationPolygon_method_get_vertices: -- :ref:`PoolVector2Array` **get_vertices** **(** **)** const +- :ref:`PackedVector2Array` **get_vertices** **(** **)** const -Returns a :ref:`PoolVector2Array` containing all the vertices being used to create the polygons. +Returns a :ref:`PackedVector2Array` containing all the vertices being used to create the polygons. ---- @@ -173,7 +173,7 @@ Removes an outline created in the editor or by script. You have to call :ref:`ma .. _class_NavigationPolygon_method_set_outline: -- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** +- void **set_outline** **(** :ref:`int` idx, :ref:`PackedVector2Array` outline **)** Changes an outline created in the editor or by script. You have to call :ref:`make_polygons_from_outlines` for the polygons to update. @@ -181,7 +181,7 @@ Changes an outline created in the editor or by script. You have to call :ref:`ma .. _class_NavigationPolygon_method_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** +- void **set_vertices** **(** :ref:`PackedVector2Array` vertices **)** Sets the vertices that can be then indexed to create polygons with the :ref:`add_polygon` method. diff --git a/classes/class_navigationregion.rst b/classes/class_navigationregion.rst new file mode 100644 index 000000000..db162d87e --- /dev/null +++ b/classes/class_navigationregion.rst @@ -0,0 +1,93 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationRegion.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationRegion: + +NavigationRegion +================ + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +A region of the navigation map. + +Description +----------- + +A region of the navigation map. It tells the :ref:`Navigation` node what can be navigated and what cannot, based on the :ref:`NavigationMesh` resource. This should be a child of a :ref:`Navigation` node (even not a direct child). + +Properties +---------- + ++---------------------------------------------+---------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++---------------------------------------------+---------------------------------------------------------+----------+ +| :ref:`NavigationMesh` | :ref:`navmesh` | | ++---------------------------------------------+---------------------------------------------------------+----------+ + +Methods +------- + ++------+---------------------------------------------------------------------------------------------+ +| void | :ref:`bake_navigation_mesh` **(** **)** | ++------+---------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_NavigationRegion_signal_bake_finished: + +- **bake_finished** **(** **)** + +Notifies when the navigation mesh bake operation is completed. + +---- + +.. _class_NavigationRegion_signal_navigation_mesh_changed: + +- **navigation_mesh_changed** **(** **)** + +Notifies when the :ref:`NavigationMesh` has changed. + +Property Descriptions +--------------------- + +.. _class_NavigationRegion_property_enabled: + +- :ref:`bool` **enabled** + ++-----------+--------------------+ +| *Default* | ``true`` | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ + +Determines if the ``NavigationRegion`` is enabled or disabled. + +---- + +.. _class_NavigationRegion_property_navmesh: + +- :ref:`NavigationMesh` **navmesh** + ++----------+----------------------------+ +| *Setter* | set_navigation_mesh(value) | ++----------+----------------------------+ +| *Getter* | get_navigation_mesh() | ++----------+----------------------------+ + +The :ref:`NavigationMesh` resource to use. + +Method Descriptions +------------------- + +.. _class_NavigationRegion_method_bake_navigation_mesh: + +- void **bake_navigation_mesh** **(** **)** + +Bakes the :ref:`NavigationMesh`. The baking is done in a separate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new :ref:`NavigationMesh`. + diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationregion2d.rst similarity index 67% rename from classes/class_navigationpolygoninstance.rst rename to classes/class_navigationregion2d.rst index 27005b7f4..0fbc28e50 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationregion2d.rst @@ -1,13 +1,13 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the NavigationPolygonInstance.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationRegion2D.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_NavigationPolygonInstance: +.. _class_NavigationRegion2D: -NavigationPolygonInstance -========================= +NavigationRegion2D +================== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` @@ -16,16 +16,16 @@ NavigationPolygonInstance Properties ---------- -+---------------------------------------------------+------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`enabled` | ``true`` | -+---------------------------------------------------+------------------------------------------------------------------+----------+ -| :ref:`NavigationPolygon` | :ref:`navpoly` | | -+---------------------------------------------------+------------------------------------------------------------------+----------+ ++---------------------------------------------------+-----------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++---------------------------------------------------+-----------------------------------------------------------+----------+ +| :ref:`NavigationPolygon` | :ref:`navpoly` | | ++---------------------------------------------------+-----------------------------------------------------------+----------+ Property Descriptions --------------------- -.. _class_NavigationPolygonInstance_property_enabled: +.. _class_NavigationRegion2D_property_enabled: - :ref:`bool` **enabled** @@ -39,7 +39,7 @@ Property Descriptions ---- -.. _class_NavigationPolygonInstance_property_navpoly: +.. _class_NavigationRegion2D_property_navpoly: - :ref:`NavigationPolygon` **navpoly** diff --git a/classes/class_navigationserver.rst b/classes/class_navigationserver.rst new file mode 100644 index 000000000..498229a58 --- /dev/null +++ b/classes/class_navigationserver.rst @@ -0,0 +1,370 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the NavigationServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_NavigationServer: + +NavigationServer +================ + +**Inherits:** :ref:`Object` + +Server interface for low-level 3D navigation access + +Description +----------- + +NavigationServer is the server responsible for all 3D navigation. It creates the agents, maps, and regions for navigation to work as expected. This keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. + +Methods +------- + ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`agent_create` **(** **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`agent_is_map_changed` **(** :ref:`RID` agent **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_callback` **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_map` **(** :ref:`RID` agent, :ref:`RID` map **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_neighbors` **(** :ref:`RID` agent, :ref:`int` count **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_max_speed` **(** :ref:`RID` agent, :ref:`float` max_speed **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_neighbor_dist` **(** :ref:`RID` agent, :ref:`float` dist **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_position` **(** :ref:`RID` agent, :ref:`Vector3` position **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_radius` **(** :ref:`RID` agent, :ref:`float` radius **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_target_velocity` **(** :ref:`RID` agent, :ref:`Vector3` target_velocity **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_time_horizon` **(** :ref:`RID` agent, :ref:`float` time **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`agent_set_velocity` **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** :ref:`RID` object **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_create` **(** **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_cell_size` **(** :ref:`RID` map **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point_normal` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`map_get_closest_point_owner` **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_closest_point_to_segment` **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`map_get_up` **(** :ref:`RID` map **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`map_is_active` **(** :ref:`RID` nap **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_active` **(** :ref:`RID` map, :ref:`bool` active **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_cell_size` **(** :ref:`RID` map, :ref:`float` cell_size **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_up` **(** :ref:`RID` map, :ref:`Vector3` up **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process` **(** :ref:`float` delta_time **)** | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_bake_navmesh` **(** :ref:`NavigationMesh` mesh, :ref:`Node` node **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`region_create` **(** **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_map` **(** :ref:`RID` region, :ref:`RID` map **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_navmesh` **(** :ref:`RID` region, :ref:`NavigationMesh` nav_mesh **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`region_set_transform` **(** :ref:`RID` region, :ref:`Transform` transform **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** const | ++-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_NavigationServer_method_agent_create: + +- :ref:`RID` **agent_create** **(** **)** const + +Creates the agent. + +---- + +.. _class_NavigationServer_method_agent_is_map_changed: + +- :ref:`bool` **agent_is_map_changed** **(** :ref:`RID` agent **)** const + +Returns true if the map got changed the previous frame. + +---- + +.. _class_NavigationServer_method_agent_set_callback: + +- void **agent_set_callback** **(** :ref:`RID` agent, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** const + +Callback called at the end of the RVO process. + +---- + +.. _class_NavigationServer_method_agent_set_map: + +- void **agent_set_map** **(** :ref:`RID` agent, :ref:`RID` map **)** const + +Puts the agent in the map. + +---- + +.. _class_NavigationServer_method_agent_set_max_neighbors: + +- void **agent_set_max_neighbors** **(** :ref:`RID` agent, :ref:`int` count **)** const + +Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. + +---- + +.. _class_NavigationServer_method_agent_set_max_speed: + +- void **agent_set_max_speed** **(** :ref:`RID` agent, :ref:`float` max_speed **)** const + +Sets the maximum speed of the agent. Must be positive. + +---- + +.. _class_NavigationServer_method_agent_set_neighbor_dist: + +- void **agent_set_neighbor_dist** **(** :ref:`RID` agent, :ref:`float` dist **)** const + +Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe. + +---- + +.. _class_NavigationServer_method_agent_set_position: + +- void **agent_set_position** **(** :ref:`RID` agent, :ref:`Vector3` position **)** const + +Sets the position of the agent in world space. + +---- + +.. _class_NavigationServer_method_agent_set_radius: + +- void **agent_set_radius** **(** :ref:`RID` agent, :ref:`float` radius **)** const + +Sets the radius of the agent. + +---- + +.. _class_NavigationServer_method_agent_set_target_velocity: + +- void **agent_set_target_velocity** **(** :ref:`RID` agent, :ref:`Vector3` target_velocity **)** const + +Sets the new target velocity. + +---- + +.. _class_NavigationServer_method_agent_set_time_horizon: + +- void **agent_set_time_horizon** **(** :ref:`RID` agent, :ref:`float` time **)** const + +The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. Must be positive. + +---- + +.. _class_NavigationServer_method_agent_set_velocity: + +- void **agent_set_velocity** **(** :ref:`RID` agent, :ref:`Vector3` velocity **)** const + +Sets the current velocity of the agent. + +---- + +.. _class_NavigationServer_method_free: + +- void **free** **(** :ref:`RID` object **)** const + +Destroy the RID + +---- + +.. _class_NavigationServer_method_map_create: + +- :ref:`RID` **map_create** **(** **)** const + +Create a new map. + +---- + +.. _class_NavigationServer_method_map_get_cell_size: + +- :ref:`float` **map_get_cell_size** **(** :ref:`RID` map **)** const + +Returns the map cell size. + +---- + +.. _class_NavigationServer_method_map_get_closest_point: + +- :ref:`Vector3` **map_get_closest_point** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const + +Returns the point closest to the provided ``point`` on the navigation mesh surface. + +---- + +.. _class_NavigationServer_method_map_get_closest_point_normal: + +- :ref:`Vector3` **map_get_closest_point_normal** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const + +Returns the normal for the point returned by :ref:`map_get_closest_point`. + +---- + +.. _class_NavigationServer_method_map_get_closest_point_owner: + +- :ref:`RID` **map_get_closest_point_owner** **(** :ref:`RID` map, :ref:`Vector3` to_point **)** const + +Returns the owner region RID for the point returned by :ref:`map_get_closest_point`. + +---- + +.. _class_NavigationServer_method_map_get_closest_point_to_segment: + +- :ref:`Vector3` **map_get_closest_point_to_segment** **(** :ref:`RID` map, :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** const + +Returns the closest point between the navigation surface and the segment. + +---- + +.. _class_NavigationServer_method_map_get_edge_connection_margin: + +- :ref:`float` **map_get_edge_connection_margin** **(** :ref:`RID` map **)** const + +Returns the edge connection margin of the map. + +---- + +.. _class_NavigationServer_method_map_get_path: + +- :ref:`PackedVector3Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize **)** const + +Returns the navigation path to reach the destination from the origin. + +---- + +.. _class_NavigationServer_method_map_get_up: + +- :ref:`Vector3` **map_get_up** **(** :ref:`RID` map **)** const + +Returns the map's up direction. + +---- + +.. _class_NavigationServer_method_map_is_active: + +- :ref:`bool` **map_is_active** **(** :ref:`RID` nap **)** const + +Returns true if the map is active. + +---- + +.. _class_NavigationServer_method_map_set_active: + +- void **map_set_active** **(** :ref:`RID` map, :ref:`bool` active **)** const + +Sets the map active. + +---- + +.. _class_NavigationServer_method_map_set_cell_size: + +- void **map_set_cell_size** **(** :ref:`RID` map, :ref:`float` cell_size **)** const + +Set the map cell size used to weld the navigation mesh polygons. + +---- + +.. _class_NavigationServer_method_map_set_edge_connection_margin: + +- void **map_set_edge_connection_margin** **(** :ref:`RID` map, :ref:`float` margin **)** const + +Set the map edge connection margein used to weld the compatible region edges. + +---- + +.. _class_NavigationServer_method_map_set_up: + +- void **map_set_up** **(** :ref:`RID` map, :ref:`Vector3` up **)** const + +Sets the map up direction. + +---- + +.. _class_NavigationServer_method_process: + +- void **process** **(** :ref:`float` delta_time **)** + +Process the collision avoidance agents. + +The result of this process is needed by the physics server, so this must be called in the main thread. + +Note: This function is not thread safe. + +---- + +.. _class_NavigationServer_method_region_bake_navmesh: + +- void **region_bake_navmesh** **(** :ref:`NavigationMesh` mesh, :ref:`Node` node **)** const + +Bakes the navigation mesh. + +---- + +.. _class_NavigationServer_method_region_create: + +- :ref:`RID` **region_create** **(** **)** const + +Creates a new region. + +---- + +.. _class_NavigationServer_method_region_set_map: + +- void **region_set_map** **(** :ref:`RID` region, :ref:`RID` map **)** const + +Sets the map for the region. + +---- + +.. _class_NavigationServer_method_region_set_navmesh: + +- void **region_set_navmesh** **(** :ref:`RID` region, :ref:`NavigationMesh` nav_mesh **)** const + +Sets the navigation mesh for the region. + +---- + +.. _class_NavigationServer_method_region_set_transform: + +- void **region_set_transform** **(** :ref:`RID` region, :ref:`Transform` transform **)** const + +Sets the global transformation for the region. + +---- + +.. _class_NavigationServer_method_set_active: + +- void **set_active** **(** :ref:`bool` active **)** const + +Control activation of this server. + diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index bcc6bcb5a..5067c56c8 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -35,6 +35,8 @@ Properties +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`CompressionMode` | :ref:`compression_mode` | ``0`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`dtls_verify` | ``true`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`bool` | refuse_new_connections | **O:** ``false`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`server_relay` | ``true`` | @@ -43,6 +45,8 @@ Properties +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`TransferMode` | transfer_mode | **O:** ``2`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ +| :ref:`bool` | :ref:`use_dtls` | ``false`` | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ Methods ------- @@ -66,6 +70,10 @@ Methods +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | +---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dtls_certificate` **(** :ref:`X509Certificate` certificate **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_dtls_key` **(** :ref:`CryptoKey` key **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -145,6 +153,22 @@ The compression method used for network packets. These have different tradeoffs ---- +.. _class_NetworkedMultiplayerENet_property_dtls_verify: + +- :ref:`bool` **dtls_verify** + ++-----------+--------------------------------+ +| *Default* | ``true`` | ++-----------+--------------------------------+ +| *Setter* | set_dtls_verify_enabled(value) | ++-----------+--------------------------------+ +| *Getter* | is_dtls_verify_enabled() | ++-----------+--------------------------------+ + +Enable or disable certificate verification when :ref:`use_dtls` ``true``. + +---- + .. _class_NetworkedMultiplayerENet_property_server_relay: - :ref:`bool` **server_relay** @@ -175,6 +199,24 @@ Enable or disable the server feature that notifies clients of other peers' conne Set the default channel to be used to transfer data. By default, this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. +---- + +.. _class_NetworkedMultiplayerENet_property_use_dtls: + +- :ref:`bool` **use_dtls** + ++-----------+-------------------------+ +| *Default* | ``false`` | ++-----------+-------------------------+ +| *Setter* | set_dtls_enabled(value) | ++-----------+-------------------------+ +| *Getter* | is_dtls_enabled() | ++-----------+-------------------------+ + +When enabled, the client or server created by this peer, will use :ref:`PacketPeerDTLS` instead of raw UDP sockets for communicating with the remote peer. This will make the communication encrypted with DTLS at the cost of higher resource usage and potentially larger packet size. + +Note: When creating a DTLS server, make sure you setup the key/certificate pair via :ref:`set_dtls_key` and :ref:`set_dtls_certificate`. For DTLS clients, have a look at the :ref:`dtls_verify` option, and configure the certificate accordingly via :ref:`set_dtls_certificate`. + Method Descriptions ------------------- @@ -248,3 +290,19 @@ Returns the remote port of the given peer. The IP used when creating a server. This is set to the wildcard ``"*"`` by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: ``"192.168.1.1"``. +---- + +.. _class_NetworkedMultiplayerENet_method_set_dtls_certificate: + +- void **set_dtls_certificate** **(** :ref:`X509Certificate` certificate **)** + +Configure the :ref:`X509Certificate` to use when :ref:`use_dtls` is ``true``. For servers, you must also setup the :ref:`CryptoKey` via :ref:`set_dtls_key`. + +---- + +.. _class_NetworkedMultiplayerENet_method_set_dtls_key: + +- void **set_dtls_key** **(** :ref:`CryptoKey` key **)** + +Configure the :ref:`CryptoKey` to use when :ref:`use_dtls` is ``true``. Remember to also call :ref:`set_dtls_certificate` to setup your :ref:`X509Certificate`. + diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 70651f2f6..adfdeaf52 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -40,7 +40,7 @@ Properties +------------------------------------------------------------+--------------------------------------------------------------------------------------+-------------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | +------------------------------------------------------------+--------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +------------------------------------------------------------+--------------------------------------------------------------------------------------+-------------------------+ Methods @@ -213,7 +213,7 @@ Rectangular region of the texture to sample from. If you're working with an atla .. _class_NinePatchRect_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_node.rst b/classes/class_node.rst index b02f70f08..fa5e0db93 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -11,7 +11,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AnimationPlayer`, :ref:`AnimationTree`, :ref:`AnimationTreePlayer`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorInterface`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`ResourcePreloader`, :ref:`SkeletonIK`, :ref:`Spatial`, :ref:`Timer`, :ref:`Tween`, :ref:`Viewport`, :ref:`WorldEnvironment` +**Inherited By:** :ref:`AnimationPlayer`, :ref:`AnimationTree`, :ref:`AudioStreamPlayer`, :ref:`CanvasItem`, :ref:`CanvasLayer`, :ref:`EditorFileSystem`, :ref:`EditorInterface`, :ref:`EditorPlugin`, :ref:`EditorResourcePreview`, :ref:`HTTPRequest`, :ref:`InstancePlaceholder`, :ref:`NavigationAgent`, :ref:`NavigationAgent2D`, :ref:`NavigationObstacle`, :ref:`NavigationObstacle2D`, :ref:`ResourcePreloader`, :ref:`SkeletonIK`, :ref:`Spatial`, :ref:`Timer`, :ref:`Tween`, :ref:`Viewport`, :ref:`WorldEnvironment` Base class for all *scene* objects. @@ -55,7 +55,7 @@ Properties +---------------------------------------------+-------------------------------------------------------------------+-------+ | :ref:`MultiplayerAPI` | :ref:`multiplayer` | | +---------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`name` | | +| :ref:`StringName` | :ref:`name` | | +---------------------------------------------+-------------------------------------------------------------------+-------+ | :ref:`Node` | :ref:`owner` | | +---------------------------------------------+-------------------------------------------------------------------+-------+ @@ -67,173 +67,173 @@ Properties Methods ------- -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node_or_null` **(** :ref:`NodePath` path **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree_pretty` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method, ... **)** vararg | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`RPCMode` mode **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method, ... **)** vararg | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`RPCMode` mode **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_configuration_warning` **(** **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child_below_node` **(** :ref:`Node` preceding_node, :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_parent` **(** :ref:`String` mask **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node_or_null` **(** :ref:`NodePath` path **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`StringName` group **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_physics_processing_internal` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree_pretty` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`StringName` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`StringName` group **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`StringName` method, ... **)** vararg | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rpc_config` **(** :ref:`StringName` method, :ref:`RPCMode` mode **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** vararg | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`StringName` method, ... **)** vararg | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** vararg | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rset_config` **(** :ref:`StringName` property, :ref:`RPCMode` mode **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_physics_process_internal` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_configuration_warning` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -515,7 +515,7 @@ The :ref:`MultiplayerAPI` instance associated with this no .. _class_Node_property_name: -- :ref:`String` **name** +- :ref:`StringName` **name** +----------+-----------------+ | *Setter* | set_name(value) | @@ -702,23 +702,27 @@ If ``legible_unique_name`` is ``true``, the child node will have an human-readab child_node.get_parent().remove_child(child_node) add_child(child_node) +If you need the child node to be added below a specific node in the list of children, use :ref:`add_child_below_node` instead of this method. + **Note:** If you want a child to be persisted to a :ref:`PackedScene`, you must set :ref:`owner` in addition to calling :ref:`add_child`. This is typically relevant for `tool scripts `_ and `editor plugins `_. If :ref:`add_child` is called without setting :ref:`owner`, the newly added ``Node`` will not be visible in the scene tree, though it will be visible in the 2D/3D view. ---- .. _class_Node_method_add_child_below_node: -- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** +- void **add_child_below_node** **(** :ref:`Node` preceding_node, :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** -Adds a child node. The child is placed below the given node in the list of children. +Adds a child node below the ``preceding_node``. If ``legible_unique_name`` is ``true``, the child node will have an human-readable name based on the name of the node being instanced instead of its type. +Use :ref:`add_child` instead of this method if you don't need the child node to be added below a specific node in the list of children. + ---- .. _class_Node_method_add_to_group: -- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** +- void **add_to_group** **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. @@ -904,7 +908,7 @@ Returns the relative :ref:`NodePath` from this node to the speci - :ref:`float` **get_physics_process_delta_time** **(** **)** const -Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed via :ref:`Engine.target_fps`. +Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed via :ref:`Engine.iterations_per_second`. ---- @@ -990,7 +994,7 @@ Returns ``true`` if the given node occurs later in the scene hierarchy than the .. _class_Node_method_is_in_group: -- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const +- :ref:`bool` **is_in_group** **(** :ref:`StringName` group **)** const Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree`. @@ -1124,7 +1128,7 @@ Similar to :ref:`print_tree`, this prints the tree .. _class_Node_method_propagate_call: -- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** +- void **propagate_call** **(** :ref:`StringName` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the given method (if present) with the arguments given in ``args`` on this node and recursively on all its children. If the ``parent_first`` argument is ``true``, the method will be called on the current node first, then on all its children. If ``parent_first`` is ``false``, the children will be called first. @@ -1172,7 +1176,7 @@ Removes a child node. The node is NOT deleted and must be deleted manually. .. _class_Node_method_remove_from_group: -- void **remove_from_group** **(** :ref:`String` group **)** +- void **remove_from_group** **(** :ref:`StringName` group **)** Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. @@ -1196,7 +1200,7 @@ Requests that ``_ready`` be called again. Note that the method won't be called i .. _class_Node_method_rpc: -- :ref:`Variant` **rpc** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc** **(** :ref:`StringName` method, ... **)** vararg Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config`. Methods are not exposed to RPCs by default. See also :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. @@ -1206,7 +1210,7 @@ Sends a remote procedure call request for the given ``method`` to peers on the n .. _class_Node_method_rpc_config: -- void **rpc_config** **(** :ref:`String` method, :ref:`RPCMode` mode **)** +- :ref:`int` **rpc_config** **(** :ref:`StringName` method, :ref:`RPCMode` mode **)** Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, methods are not exposed to networking (and RPCs). See also :ref:`rset` and :ref:`rset_config` for properties. @@ -1214,7 +1218,7 @@ Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`R .. _class_Node_method_rpc_id: -- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** vararg Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. @@ -1222,7 +1226,7 @@ Sends a :ref:`rpc` to a specific peer identified by ``pee .. _class_Node_method_rpc_unreliable: -- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_unreliable** **(** :ref:`StringName` method, ... **)** vararg Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. @@ -1230,7 +1234,7 @@ Sends a :ref:`rpc` using an unreliable protocol. Returns .. _class_Node_method_rpc_unreliable_id: -- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`StringName` method, ... **)** vararg Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. @@ -1238,7 +1242,7 @@ Sends a :ref:`rpc` to a specific peer identified by ``pee .. _class_Node_method_rset: -- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset** **(** :ref:`StringName` property, :ref:`Variant` value **)** Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see :ref:`rset_config`. See also :ref:`rpc` for RPCs for methods, most information applies to this method as well. @@ -1246,7 +1250,7 @@ Remotely changes a property's value on other peers (and locally). Behaviour depe .. _class_Node_method_rset_config: -- void **rset_config** **(** :ref:`String` property, :ref:`RPCMode` mode **)** +- :ref:`int` **rset_config** **(** :ref:`StringName` property, :ref:`RPCMode` mode **)** Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, properties are not exposed to networking (and RPCs). See also :ref:`rpc` and :ref:`rpc_config` for methods. @@ -1254,7 +1258,7 @@ Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref: .. _class_Node_method_rset_id: -- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_id** **(** :ref:`int` peer_id, :ref:`StringName` property, :ref:`Variant` value **)** Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). @@ -1262,7 +1266,7 @@ Remotely changes the property's value on a specific peer identified by ``peer_id .. _class_Node_method_rset_unreliable: -- void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable** **(** :ref:`StringName` property, :ref:`Variant` value **)** Remotely changes the property's value on other peers (and locally) using an unreliable protocol. @@ -1270,7 +1274,7 @@ Remotely changes the property's value on other peers (and locally) using an unre .. _class_Node_method_rset_unreliable_id: -- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`StringName` property, :ref:`Variant` value **)** Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). @@ -1296,7 +1300,7 @@ Sets the node's network master to the peer with the given peer ID. The network m - void **set_physics_process** **(** :ref:`bool` enable **)** -Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS` at a fixed (usually 60 FPS, see :ref:`Engine.target_fps` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a :ref:`NOTIFICATION_PHYSICS_PROCESS` at a fixed (usually 60 FPS, see :ref:`Engine.iterations_per_second` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. ---- diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index f26d88d96..6245b6f83 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -11,7 +11,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedSprite`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`Navigation2D`, :ref:`NavigationPolygonInstance`, :ref:`ParallaxLayer`, :ref:`Particles2D`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`Skeleton2D`, :ref:`Sprite`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibilityNotifier2D`, :ref:`YSort` +**Inherited By:** :ref:`AnimatedSprite`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`Navigation2D`, :ref:`NavigationRegion2D`, :ref:`ParallaxLayer`, :ref:`Particles2D`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`Skeleton2D`, :ref:`Sprite`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibilityNotifier2D`, :ref:`YSort` A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index. diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index e72f1807e..225c02e93 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -9,7 +9,7 @@ NoiseTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` :ref:`OpenSimplexNoise` filled texture. @@ -20,7 +20,7 @@ Uses an :ref:`OpenSimplexNoise` to fill the texture data NoiseTexture can also generate normalmap textures. -The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture.get_data` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the data: +The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture2D.get_data` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the data: :: @@ -31,21 +31,19 @@ The class uses :ref:`Thread`\ s to generate the texture data inter Properties ---------- -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`as_normalmap` | ``false`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`bump_strength` | ``8.0`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`int` | flags | **O:** ``7`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`height` | ``512`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`OpenSimplexNoise` | :ref:`noise` | | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`seamless` | ``false`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`width` | ``512`` | -+-------------------------------------------------+-----------------------------------------------------------------+--------------+ ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`as_normalmap` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`bump_strength` | ``8.0`` | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`height` | ``512`` | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`OpenSimplexNoise` | :ref:`noise` | | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`seamless` | ``false`` | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`width` | ``512`` | ++-------------------------------------------------+-----------------------------------------------------------------+-----------+ Property Descriptions --------------------- diff --git a/classes/class_object.rst b/classes/class_object.rst index 99cc8806c..530074590 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -9,7 +9,7 @@ Object ====== -**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorNavigationMeshGenerator`, :ref:`EditorSelection`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JSONRPC`, :ref:`JavaClassWrapper`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` +**Inherited By:** :ref:`ARVRPositionalTracker`, :ref:`ARVRServer`, :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`EditorFileSystemDirectory`, :ref:`EditorSelection`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`Geometry`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JSON`, :ref:`JSONRPC`, :ref:`JavaClassWrapper`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`Navigation2DServer`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`Physics2DDirectBodyState`, :ref:`Physics2DDirectSpaceState`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`PhysicsDirectSpaceState`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`Reference`, :ref:`RenderingDevice`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`VisualScriptEditor`, :ref:`VisualServer` Base class for all non built-in types. @@ -39,99 +39,99 @@ Objects also receive notifications. Notifications are a simple way to notify the Methods ------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_to_string` **(** **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method, ... **)** vararg | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method, ... **)** vararg | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal, ... **)** vararg | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_id` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` class **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_meta` **(** :ref:`String` name **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deferred` **(** :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Reference` script **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_string` **(** **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_get` **(** :ref:`StringName` property **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_set` **(** :ref:`StringName` property, :ref:`Variant` value **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_to_string` **(** **)** virtual | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`StringName` method, ... **)** vararg | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** :ref:`StringName` method, ... **)** vararg | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`StringName` method, :ref:`Array` arg_array **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect` **(** :ref:`StringName` signal, :ref:`Callable` callable, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`StringName` signal, :ref:`Callable` callable **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit_signal` **(** :ref:`StringName` signal, ... **)** vararg | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_id` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_meta_list` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_script` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`StringName` method **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`StringName` signal **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` class **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`StringName` signal, :ref:`Callable` callable **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_meta` **(** :ref:`String` name **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deferred` **(** :ref:`StringName` property, :ref:`Variant` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Variant` script **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_string` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`tr` **(** :ref:`StringName` message **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -181,7 +181,7 @@ Method Descriptions .. _class_Object_method__get: -- :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual +- :ref:`Variant` **_get** **(** :ref:`StringName` property **)** virtual Virtual method which can be overridden to customize the return value of :ref:`get`. @@ -219,7 +219,7 @@ Called whenever the object receives a notification, which is identified in ``wha .. _class_Object_method__set: -- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual +- :ref:`bool` **_set** **(** :ref:`StringName` property, :ref:`Variant` value **)** virtual Virtual method which can be overridden to customize the return value of :ref:`set`. @@ -247,7 +247,7 @@ Adds a user-defined ``signal``. Arguments are optional, but can be added as an : .. _class_Object_method_call: -- :ref:`Variant` **call** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call** **(** :ref:`StringName` method, ... **)** vararg Calls the ``method`` on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -259,7 +259,7 @@ Calls the ``method`` on the object and returns the result. This method supports .. _class_Object_method_call_deferred: -- void **call_deferred** **(** :ref:`String` method, ... **)** vararg +- void **call_deferred** **(** :ref:`StringName` method, ... **)** vararg Calls the ``method`` on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -271,7 +271,7 @@ Calls the ``method`` on the object during idle time. This method supports a vari .. _class_Object_method_callv: -- :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** +- :ref:`Variant` **callv** **(** :ref:`StringName` method, :ref:`Array` arg_array **)** Calls the ``method`` on the object and returns the result. Contrarily to :ref:`call`, this method does not support a variable number of arguments but expects all parameters to be via a single :ref:`Array`. @@ -291,7 +291,9 @@ Returns ``true`` if the object can translate strings. See :ref:`set_message_tran .. _class_Object_method_connect: -- :ref:`Error` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** +- :ref:`Error` **connect** **(** :ref:`StringName` signal, :ref:`Callable` callable, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** + +**FIXME:** The syntax changed with the addition of :ref:`Callable`, this should be updated. Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call as an :ref:`Array` of parameters. These parameters will be passed to the method after any parameter used in the call to :ref:`emit_signal`. Use ``flags`` to set deferred or one-shot connections. See :ref:`ConnectFlags` constants. @@ -320,7 +322,9 @@ An example of the relationship between ``binds`` passed to :ref:`connect` signal, :ref:`Object` target, :ref:`String` method **)** +- void **disconnect** **(** :ref:`StringName` signal, :ref:`Callable` callable **)** + +**FIXME:** The syntax changed with the addition of :ref:`Callable`, this should be updated. Disconnects a ``signal`` from a ``method`` on the given ``target``. @@ -330,7 +334,7 @@ If you try to disconnect a connection that does not exist, the method will throw .. _class_Object_method_emit_signal: -- void **emit_signal** **(** :ref:`String` signal, ... **)** vararg +- void **emit_signal** **(** :ref:`StringName` signal, ... **)** vararg Emits the given ``signal``. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: @@ -409,9 +413,9 @@ Returns the object's metadata entry for the given ``name``. .. _class_Object_method_get_meta_list: -- :ref:`PoolStringArray` **get_meta_list** **(** **)** const +- :ref:`PackedStringArray` **get_meta_list** **(** **)** const -Returns the object's metadata as a :ref:`PoolStringArray`. +Returns the object's metadata as a :ref:`PackedStringArray`. ---- @@ -435,7 +439,7 @@ Each property's :ref:`Dictionary` contain at least ``name: Str .. _class_Object_method_get_script: -- :ref:`Reference` **get_script** **(** **)** const +- :ref:`Variant` **get_script** **(** **)** const Returns the object's :ref:`Script` instance, or ``null`` if none is assigned. @@ -467,7 +471,7 @@ Returns ``true`` if a metadata entry is found with the given ``name``. .. _class_Object_method_has_method: -- :ref:`bool` **has_method** **(** :ref:`String` method **)** const +- :ref:`bool` **has_method** **(** :ref:`StringName` method **)** const Returns ``true`` if the object contains the given ``method``. @@ -475,7 +479,7 @@ Returns ``true`` if the object contains the given ``method``. .. _class_Object_method_has_user_signal: -- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const +- :ref:`bool` **has_user_signal** **(** :ref:`StringName` signal **)** const Returns ``true`` if the given user-defined ``signal`` exists. @@ -499,7 +503,9 @@ Returns ``true`` if the object inherits from the given ``class``. .. _class_Object_method_is_connected: -- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const +- :ref:`bool` **is_connected** **(** :ref:`StringName` signal, :ref:`Callable` callable **)** const + +**FIXME:** The syntax changed with the addition of :ref:`Callable`, this should be updated. Returns ``true`` if a connection exists for a given ``signal``, ``target``, and ``method``. @@ -557,7 +563,7 @@ If set to ``true``, signal emission is blocked. .. _class_Object_method_set_deferred: -- void **set_deferred** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **set_deferred** **(** :ref:`StringName` property, :ref:`Variant` value **)** Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling :ref:`set` via :ref:`call_deferred`, i.e. ``call_deferred("set", property, value)``. @@ -595,7 +601,7 @@ Adds or changes a given entry in the object's metadata. Metadata are serialized, .. _class_Object_method_set_script: -- void **set_script** **(** :ref:`Reference` script **)** +- void **set_script** **(** :ref:`Variant` script **)** Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. @@ -615,7 +621,7 @@ Override the method :ref:`_to_string` to customi .. _class_Object_method_tr: -- :ref:`String` **tr** **(** :ref:`String` message **)** const +- :ref:`StringName` **tr** **(** :ref:`StringName` message **)** const Translates a message using translation catalogs configured in the Project Settings. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index fcae3a5d8..612b97733 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -21,13 +21,13 @@ Editor facility that helps you draw a 2D polygon used as resource for :ref:`Ligh Properties ---------- -+--------------------------------------------------+--------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`closed` | ``true`` | -+--------------------------------------------------+--------------------------------------------------------------+--------------------------+ -| :ref:`CullMode` | :ref:`cull_mode` | ``0`` | -+--------------------------------------------------+--------------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( )`` | -+--------------------------------------------------+--------------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+--------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`closed` | ``true`` | ++-----------------------------------------------------+--------------------------------------------------------------+----------------------------+ +| :ref:`CullMode` | :ref:`cull_mode` | ``0`` | ++-----------------------------------------------------+--------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`polygon` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+--------------------------------------------------------------+----------------------------+ Enumerations ------------ @@ -85,15 +85,15 @@ The culling mode to use. .. _class_OccluderPolygon2D_property_polygon: -- :ref:`PoolVector2Array` **polygon** +- :ref:`PackedVector2Array` **polygon** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_polygon(value) | -+-----------+--------------------------+ -| *Getter* | get_polygon() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------------+ A :ref:`Vector2` array with the index for polygon's vertices positions. diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index cd9e43833..d7865d5e1 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -26,15 +26,13 @@ Tutorials Properties ---------- -+--------------------------------------------------+------------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`omni_attenuation` | ``1.0`` | -+--------------------------------------------------+------------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`omni_range` | ``5.0`` | -+--------------------------------------------------+------------------------------------------------------------------------+---------+ -| :ref:`ShadowDetail` | :ref:`omni_shadow_detail` | ``1`` | -+--------------------------------------------------+------------------------------------------------------------------------+---------+ -| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | ``1`` | -+--------------------------------------------------+------------------------------------------------------------------------+---------+ ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`omni_attenuation` | ``1.0`` | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`omni_range` | ``5.0`` | ++----------------------------------------------+--------------------------------------------------------------------+---------+ +| :ref:`ShadowMode` | :ref:`omni_shadow_mode` | ``1`` | ++----------------------------------------------+--------------------------------------------------------------------+---------+ Enumerations ------------ @@ -51,20 +49,6 @@ enum **ShadowMode**: - **SHADOW_CUBE** = **1** --- Shadows are rendered to a cubemap. Slower than :ref:`SHADOW_DUAL_PARABOLOID`, but higher-quality. ----- - -.. _enum_OmniLight_ShadowDetail: - -.. _class_OmniLight_constant_SHADOW_DETAIL_VERTICAL: - -.. _class_OmniLight_constant_SHADOW_DETAIL_HORIZONTAL: - -enum **ShadowDetail**: - -- **SHADOW_DETAIL_VERTICAL** = **0** --- Use more detail vertically when computing the shadow. - -- **SHADOW_DETAIL_HORIZONTAL** = **1** --- Use more detail horizontally when computing the shadow. - Property Descriptions --------------------- @@ -100,22 +84,6 @@ The light's radius. ---- -.. _class_OmniLight_property_omni_shadow_detail: - -- :ref:`ShadowDetail` **omni_shadow_detail** - -+-----------+--------------------------+ -| *Default* | ``1`` | -+-----------+--------------------------+ -| *Setter* | set_shadow_detail(value) | -+-----------+--------------------------+ -| *Getter* | get_shadow_detail() | -+-----------+--------------------------+ - -See :ref:`ShadowDetail`. - ----- - .. _class_OmniLight_property_omni_shadow_mode: - :ref:`ShadowMode` **omni_shadow_mode** diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index 4b1a879ac..9d61b4078 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -101,7 +101,9 @@ Difference in period between :ref:`octaves` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected_id` **(** **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` idx **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1 **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selected_id` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` idx **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` texture **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | arrow | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | arrow_margin | 2 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | disabled | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | hover | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | hseparation | 2 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | pressed | | -+---------------------------------+---------------------+------------------------------+ ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | arrow | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`int` | arrow_margin | 2 | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | disabled | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_pressed | Color( 1, 1, 1, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | hover | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`int` | hseparation | 2 | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | pressed | | ++-----------------------------------+---------------------+------------------------------+ Signals ------- @@ -146,7 +146,7 @@ Method Descriptions .. _class_OptionButton_method_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** +- void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1 **)** Adds an item, with a ``texture`` icon, text ``label`` and (optionally) ``id``. If no ``id`` is passed, the item index will be used as the item's ID. New items are appended at the end. @@ -186,7 +186,7 @@ Returns the amount of items in the OptionButton, including separators. .. _class_OptionButton_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon of the item at index ``idx``. @@ -284,7 +284,7 @@ Disabled items are drawn differently in the dropdown and are not selectable by t .. _class_OptionButton_method_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture2D` texture **)** Sets the icon of the item at index ``idx``. diff --git a/classes/class_ormmaterial3d.rst b/classes/class_ormmaterial3d.rst new file mode 100644 index 000000000..020f60a62 --- /dev/null +++ b/classes/class_ormmaterial3d.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ORMMaterial3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ORMMaterial3D: + +ORMMaterial3D +============= + +**Inherits:** :ref:`BaseMaterial3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + + + diff --git a/classes/class_os.rst b/classes/class_os.rst index e036068ae..6fa5bac2d 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -64,205 +64,197 @@ Properties Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_draw` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_window` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close_midi_inputs` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking=true, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_granted_permissions` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_ime_text` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_percent_left` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_id` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_processor_count` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_add_item` **(** :ref:`String` menu, :ref:`String` label, :ref:`Variant` id, :ref:`Variant` meta **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_add_separator` **(** :ref:`String` menu **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_clear` **(** :ref:`String` menu **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_remove_item` **(** :ref:`String` menu, :ref:`int` idx **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide_virtual_keyboard` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scancode_unicode` **(** :ref:`int` code **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_window_focused` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_window_to_foreground` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_pause` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_stop` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`native_video_unpause` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_midi_inputs` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_textures_by_size` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_attention` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`request_permission` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`request_permissions` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_draw` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_use_threads` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_window` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_midi_inputs` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`bool` blocking=true, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_keycode_from_string` **(** :ref:`String` string **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_cmdline_args` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VideoDriver` | :ref:`get_current_video_driver` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_granted_permissions` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_ime_text` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_keycode_string` **(** :ref:`int` code **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_model_name` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_id` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_processor_count` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_peak_usage` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`VideoDriver` driver **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_add_item` **(** :ref:`String` menu, :ref:`String` label, :ref:`Variant` id, :ref:`Variant` meta **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_add_separator` **(** :ref:`String` menu **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_clear` **(** :ref:`String` menu **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_remove_item` **(** :ref:`String` menu, :ref:`int` idx **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_virtual_keyboard` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide_virtual_keyboard` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debug_build` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_keycode_unicode` **(** :ref:`int` code **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ok_left_and_cancel_right` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_stdout_verbose` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_userfs_persistent` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_window_focused` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_window_to_foreground` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_pause` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_stop` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`native_video_unpause` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_midi_inputs` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_textures_by_size` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_by_type` **(** :ref:`PackedStringArray` types **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_attention` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`request_permission` **(** :ref:`String` name **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`request_permissions` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -271,13 +263,13 @@ Enumerations .. _class_OS_constant_VIDEO_DRIVER_GLES2: -.. _class_OS_constant_VIDEO_DRIVER_GLES3: +.. _class_OS_constant_VIDEO_DRIVER_VULKAN: enum **VideoDriver**: -- **VIDEO_DRIVER_GLES2** = **1** --- The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. +- **VIDEO_DRIVER_GLES2** = **0** --- The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. -- **VIDEO_DRIVER_GLES3** = **0** --- The GLES3 rendering backend. It uses OpenGL ES 3.0 on mobile devices, OpenGL 3.3 on desktop platforms and WebGL 2.0 on the web. +- **VIDEO_DRIVER_VULKAN** = **1** --- The Vulkan rendering backend. ---- @@ -439,32 +431,6 @@ enum **SystemDir**: - **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path. ----- - -.. _enum_OS_PowerState: - -.. _class_OS_constant_POWERSTATE_UNKNOWN: - -.. _class_OS_constant_POWERSTATE_ON_BATTERY: - -.. _class_OS_constant_POWERSTATE_NO_BATTERY: - -.. _class_OS_constant_POWERSTATE_CHARGING: - -.. _class_OS_constant_POWERSTATE_CHARGED: - -enum **PowerState**: - -- **POWERSTATE_UNKNOWN** = **0** --- Unknown powerstate. - -- **POWERSTATE_ON_BATTERY** = **1** --- Unplugged, running on battery. - -- **POWERSTATE_NO_BATTERY** = **2** --- Plugged in, no battery available. - -- **POWERSTATE_CHARGING** = **3** --- Plugged in, battery charging. - -- **POWERSTATE_CHARGED** = **4** --- Plugged in, battery fully charged. - Property Descriptions --------------------- @@ -734,7 +700,7 @@ Use ``get_tree().get_root().set_transparent_background(true)`` to disable main v **Note:** This property has no effect if **Project > Project Settings > Display > Window > Per-pixel transparency > Allowed** setting is disabled. -**Note:** This property is implemented on Linux, macOS and Windows. +**Note:** This property is implemented on HTML5, Linux, macOS and Windows. ---- @@ -869,7 +835,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_method_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking=true, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PackedStringArray` arguments, :ref:`bool` blocking=true, :ref:`Array` output=[ ], :ref:`bool` read_stderr=false **)** Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. @@ -906,11 +872,11 @@ If you wish to access a shell built-in or perform a composite command, a platfor ---- -.. _class_OS_method_find_scancode_from_string: +.. _class_OS_method_find_keycode_from_string: -- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const +- :ref:`int` **find_keycode_from_string** **(** :ref:`String` string **)** const -Returns the scancode of the given string (e.g. "Escape"). +Returns the keycode of the given string (e.g. "Escape"). ---- @@ -932,7 +898,7 @@ Returns the audio driver name for the given index. .. _class_OS_method_get_cmdline_args: -- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** +- :ref:`PackedStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. @@ -940,7 +906,7 @@ Returns the command line arguments passed to the engine. .. _class_OS_method_get_connected_midi_inputs: -- :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** +- :ref:`PackedStringArray` **get_connected_midi_inputs** **(** **)** Returns an array of MIDI device names. @@ -984,14 +950,6 @@ The returned Dictionary's values will be the same as :ref:`get_datetime` **get_dynamic_memory_usage** **(** **)** const - -Returns the total amount of dynamic memory used (only works in debug). - ----- - .. _class_OS_method_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const @@ -1010,7 +968,7 @@ Returns the path to the current engine executable. .. _class_OS_method_get_granted_permissions: -- :ref:`PoolStringArray` **get_granted_permissions** **(** **)** const +- :ref:`PackedStringArray` **get_granted_permissions** **(** **)** const With this function you can get the list of dangerous permissions that have been granted to the Android application. @@ -1042,6 +1000,16 @@ Returns the IME intermediate composition string. ---- +.. _class_OS_method_get_keycode_string: + +- :ref:`String` **get_keycode_string** **(** :ref:`int` code **)** const + +Returns the given keycode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``). + +See also :ref:`InputEventKey.keycode` and :ref:`InputEventKey.get_keycode_with_modifiers`. + +---- + .. _class_OS_method_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -1080,36 +1048,6 @@ Returns the name of the host OS. Possible values are: ``"Android"``, ``"Haiku"`` ---- -.. _class_OS_method_get_power_percent_left: - -- :ref:`int` **get_power_percent_left** **(** **)** - -Returns the amount of battery left in the device as a percentage. Returns ``-1`` if power state is unknown. - -**Note:** This method is implemented on Linux, macOS and Windows. - ----- - -.. _class_OS_method_get_power_seconds_left: - -- :ref:`int` **get_power_seconds_left** **(** **)** - -Returns an estimate of the time left in seconds before the device runs out of battery. Returns ``-1`` if power state is unknown. - -**Note:** This method is implemented on Linux, macOS and Windows. - ----- - -.. _class_OS_method_get_power_state: - -- :ref:`PowerState` **get_power_state** **(** **)** - -Returns the current state of the device regarding battery and power. See :ref:`PowerState` constants. - -**Note:** This method is implemented on Linux, macOS and Windows. - ----- - .. _class_OS_method_get_process_id: - :ref:`int` **get_process_id** **(** **)** const @@ -1136,16 +1074,6 @@ Returns the window size including decorations like window borders. ---- -.. _class_OS_method_get_scancode_string: - -- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const - -Returns the given scancode as a string (e.g. Return values: ``"Escape"``, ``"Shift+Escape"``). - -See also :ref:`InputEventKey.scancode` and :ref:`InputEventKey.get_scancode_with_modifiers`. - ----- - .. _class_OS_method_get_screen_count: - :ref:`int` **get_screen_count** **(** **)** const @@ -1445,6 +1373,14 @@ To check whether the Godot binary used to run the project is an export template ---- +.. _class_OS_method_is_keycode_unicode: + +- :ref:`bool` **is_keycode_unicode** **(** :ref:`int` code **)** const + +Returns ``true`` if the input keycode corresponds to a Unicode character. + +---- + .. _class_OS_method_is_ok_left_and_cancel_right: - :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const @@ -1453,14 +1389,6 @@ Returns ``true`` if the **OK** button should appear on the left and **Cancel** o ---- -.. _class_OS_method_is_scancode_unicode: - -- :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const - -Returns ``true`` if the input scancode corresponds to a Unicode character. - ----- - .. _class_OS_method_is_stdout_verbose: - :ref:`bool` **is_stdout_verbose** **(** **)** const @@ -1595,7 +1523,7 @@ Shows the list of loaded textures sorted by size in memory. .. _class_OS_method_print_resources_by_type: -- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** +- void **print_resources_by_type** **(** :ref:`PackedStringArray` types **)** Shows the number of resources loaded by the game of the given types. diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst new file mode 100644 index 000000000..6d17bb0fe --- /dev/null +++ b/classes/class_packedbytearray.rst @@ -0,0 +1,201 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedByteArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedByteArray: + +PackedByteArray +=============== + +A packed :ref:`Array` of bytes. + +Description +----------- + +An :ref:`Array` specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +Methods +------- + ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`PackedByteArray` **(** :ref:`Array` from **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedByteArray` array **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`hex_encode` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | ++-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedByteArray_method_PackedByteArray: + +- :ref:`PackedByteArray` **PackedByteArray** **(** :ref:`Array` from **)** + +Constructs a new ``PackedByteArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedByteArray_method_append: + +- void **append** **(** :ref:`int` byte **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedByteArray_method_append_array: + +- void **append_array** **(** :ref:`PackedByteArray` array **)** + +Appends a ``PackedByteArray`` at the end of this array. + +---- + +.. _class_PackedByteArray_method_compress: + +- :ref:`PackedByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** + +Returns a new ``PackedByteArray`` with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. + +---- + +.. _class_PackedByteArray_method_decompress: + +- :ref:`PackedByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** + +Returns a new ``PackedByteArray`` with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode`'s constants. + +---- + +.. _class_PackedByteArray_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedByteArray_method_get_string_from_ascii: + +- :ref:`String` **get_string_from_ascii** **(** **)** + +Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. + +---- + +.. _class_PackedByteArray_method_get_string_from_utf8: + +- :ref:`String` **get_string_from_utf8** **(** **)** + +Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. + +---- + +.. _class_PackedByteArray_method_hex_encode: + +- :ref:`String` **hex_encode** **(** **)** + +Returns a hexadecimal representation of this array as a :ref:`String`. + +:: + + var array = PackedByteArray([11, 46, 255]) + print(array.hex_encode()) # Prints: 0b2eff + +---- + +.. _class_PackedByteArray_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedByteArray_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedByteArray_method_push_back: + +- void **push_back** **(** :ref:`int` byte **)** + +Appends an element at the end of the array. + +---- + +.. _class_PackedByteArray_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedByteArray_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedByteArray_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** + +Changes the byte at the given index. + +---- + +.. _class_PackedByteArray_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + +---- + +.. _class_PackedByteArray_method_subarray: + +- :ref:`PackedByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** + +Returns the slice of the ``PackedByteArray`` between indices (inclusive) as a new ``PackedByteArray``. Any negative index is considered to be from the end of the array. + diff --git a/classes/class_poolvector3array.rst b/classes/class_packedcolorarray.rst similarity index 64% rename from classes/class_poolvector3array.rst rename to classes/class_packedcolorarray.rst index 091ec4424..6bc8f8ecd 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_packedcolorarray.rst @@ -1,20 +1,20 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolVector3Array.xml source instead. +.. DO NOT EDIT THIS FILE, but the PackedColorArray.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_PoolVector3Array: +.. _class_PackedColorArray: -PoolVector3Array +PackedColorArray ================ -A pooled :ref:`Array` of :ref:`Vector3`. +A packed :ref:`Array` of :ref:`Color`\ s. Description ----------- -An :ref:`Array` specifically designed to hold :ref:`Vector3`. Optimized for memory usage, does not fragment the memory. +An :ref:`Array` specifically designed to hold :ref:`Color`. Packs data tightly, so it saves memory for large array sizes. **Note:** This type is passed by value and not by reference. @@ -22,57 +22,57 @@ Methods ------- +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | +| :ref:`PackedColorArray` | :ref:`PackedColorArray` **(** :ref:`Array` from **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | +| void | :ref:`append` **(** :ref:`Color` color **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | +| void | :ref:`append_array` **(** :ref:`PackedColorArray` array **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | +| :ref:`bool` | :ref:`empty` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | +| void | :ref:`invert` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | +| void | :ref:`push_back` **(** :ref:`Color` color **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | +| void | :ref:`remove` **(** :ref:`int` idx **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | +| void | :ref:`resize` **(** :ref:`int` idx **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | +| :ref:`int` | :ref:`size` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PoolVector3Array_method_PoolVector3Array: +.. _class_PackedColorArray_method_PackedColorArray: -- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** +- :ref:`PackedColorArray` **PackedColorArray** **(** :ref:`Array` from **)** -Constructs a new ``PoolVector3Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +Constructs a new ``PackedColorArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ---- -.. _class_PoolVector3Array_method_append: +.. _class_PackedColorArray_method_append: -- void **append** **(** :ref:`Vector3` vector3 **)** +- void **append** **(** :ref:`Color` color **)** -Appends an element at the end of the array (alias of :ref:`push_back`). +Appends an element at the end of the array (alias of :ref:`push_back`). ---- -.. _class_PoolVector3Array_method_append_array: +.. _class_PackedColorArray_method_append_array: -- void **append_array** **(** :ref:`PoolVector3Array` array **)** +- void **append_array** **(** :ref:`PackedColorArray` array **)** -Appends a ``PoolVector3Array`` at the end of this array. +Appends a ``PackedColorArray`` at the end of this array. ---- -.. _class_PoolVector3Array_method_empty: +.. _class_PackedColorArray_method_empty: - :ref:`bool` **empty** **(** **)** @@ -80,15 +80,15 @@ Returns ``true`` if the array is empty. ---- -.. _class_PoolVector3Array_method_insert: +.. _class_PackedColorArray_method_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). ---- -.. _class_PoolVector3Array_method_invert: +.. _class_PackedColorArray_method_invert: - void **invert** **(** **)** @@ -96,15 +96,15 @@ Reverses the order of the elements in the array. ---- -.. _class_PoolVector3Array_method_push_back: +.. _class_PackedColorArray_method_push_back: -- void **push_back** **(** :ref:`Vector3` vector3 **)** +- void **push_back** **(** :ref:`Color` color **)** -Inserts a :ref:`Vector3` at the end. +Appends a value to the array. ---- -.. _class_PoolVector3Array_method_remove: +.. _class_PackedColorArray_method_remove: - void **remove** **(** :ref:`int` idx **)** @@ -112,7 +112,7 @@ Removes an element from the array by index. ---- -.. _class_PoolVector3Array_method_resize: +.. _class_PackedColorArray_method_resize: - void **resize** **(** :ref:`int` idx **)** @@ -120,15 +120,15 @@ Sets the size of the array. If the array is grown, reserves elements at the end ---- -.. _class_PoolVector3Array_method_set: +.. _class_PackedColorArray_method_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** -Changes the :ref:`Vector3` at the given index. +Changes the :ref:`Color` at the given index. ---- -.. _class_PoolVector3Array_method_size: +.. _class_PackedColorArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 692d1c884..267bffc8b 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -16,9 +16,9 @@ PackedDataContainer Properties ---------- -+-------------------------------------------+--------------------------------------------------------------+-----------------------+ -| :ref:`PoolByteArray` | :ref:`__data__` | ``PoolByteArray( )`` | -+-------------------------------------------+--------------------------------------------------------------+-----------------------+ ++-----------------------------------------------+--------------------------------------------------------------+-------------------------+ +| :ref:`PackedByteArray` | :ref:`__data__` | ``PackedByteArray( )`` | ++-----------------------------------------------+--------------------------------------------------------------+-------------------------+ Methods ------- @@ -34,11 +34,11 @@ Property Descriptions .. _class_PackedDataContainer_property___data__: -- :ref:`PoolByteArray` **__data__** +- :ref:`PackedByteArray` **__data__** -+-----------+-----------------------+ -| *Default* | ``PoolByteArray( )`` | -+-----------+-----------------------+ ++-----------+-------------------------+ +| *Default* | ``PackedByteArray( )`` | ++-----------+-------------------------+ Method Descriptions ------------------- diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 08be38c2e..e8c57a892 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -11,7 +11,7 @@ PackedDataContainerRef **Inherits:** :ref:`Reference` **<** :ref:`Object` - +Reference version of :ref:`PackedDataContainer`. Methods ------- diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst new file mode 100644 index 000000000..5008c74fd --- /dev/null +++ b/classes/class_packedfloat32array.rst @@ -0,0 +1,138 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedFloat32Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedFloat32Array: + +PackedFloat32Array +================== + +A packed :ref:`Array` of 32-bit floating-point values. + +Description +----------- + +An :ref:`Array` specifically designed to hold 32-bit floating-point values. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array`. + +Methods +------- + ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`PackedFloat32Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedFloat32Array` array **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedFloat32Array_method_PackedFloat32Array: + +- :ref:`PackedFloat32Array` **PackedFloat32Array** **(** :ref:`Array` from **)** + +Constructs a new ``PackedFloat32Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedFloat32Array_method_append: + +- void **append** **(** :ref:`float` value **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedFloat32Array_method_append_array: + +- void **append_array** **(** :ref:`PackedFloat32Array` array **)** + +Appends a ``PackedFloat32Array`` at the end of this array. + +---- + +.. _class_PackedFloat32Array_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedFloat32Array_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedFloat32Array_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedFloat32Array_method_push_back: + +- void **push_back** **(** :ref:`float` value **)** + +Appends an element at the end of the array. + +---- + +.. _class_PackedFloat32Array_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedFloat32Array_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedFloat32Array_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`float` value **)** + +Changes the float at the given index. + +---- + +.. _class_PackedFloat32Array_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst new file mode 100644 index 000000000..3c59b47dd --- /dev/null +++ b/classes/class_packedfloat64array.rst @@ -0,0 +1,138 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedFloat64Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedFloat64Array: + +PackedFloat64Array +================== + +A packed :ref:`Array` of 64-bit floating-point values. + +Description +----------- + +An :ref:`Array` specifically designed to hold 64-bit floating-point values. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array` for a more memory-friendly alternative. + +Methods +------- + ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat64Array` | :ref:`PackedFloat64Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedFloat64Array` array **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedFloat64Array_method_PackedFloat64Array: + +- :ref:`PackedFloat64Array` **PackedFloat64Array** **(** :ref:`Array` from **)** + +Constructs a new ``PackedFloat64Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedFloat64Array_method_append: + +- void **append** **(** :ref:`float` value **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedFloat64Array_method_append_array: + +- void **append_array** **(** :ref:`PackedFloat64Array` array **)** + +Appends a ``PackedFloat64Array`` at the end of this array. + +---- + +.. _class_PackedFloat64Array_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedFloat64Array_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedFloat64Array_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedFloat64Array_method_push_back: + +- void **push_back** **(** :ref:`float` value **)** + +Appends an element at the end of the array. + +---- + +.. _class_PackedFloat64Array_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedFloat64Array_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedFloat64Array_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`float` value **)** + +Changes the float at the given index. + +---- + +.. _class_PackedFloat64Array_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst new file mode 100644 index 000000000..cecbfd320 --- /dev/null +++ b/classes/class_packedint32array.rst @@ -0,0 +1,138 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedInt32Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedInt32Array: + +PackedInt32Array +================ + +A packed :ref:`Array` of 32-bit integers. + +Description +----------- + +An :ref:`Array` specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +**Note:** This type stores signed 32-bit integers, which means it can take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see :ref:`PackedInt64Array`. + +Methods +------- + ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`PackedInt32Array` **(** :ref:`Array` from **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` integer **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedInt32Array` array **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` integer **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedInt32Array_method_PackedInt32Array: + +- :ref:`PackedInt32Array` **PackedInt32Array** **(** :ref:`Array` from **)** + +Constructs a new ``PackedInt32Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedInt32Array_method_append: + +- void **append** **(** :ref:`int` integer **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedInt32Array_method_append_array: + +- void **append_array** **(** :ref:`PackedInt32Array` array **)** + +Appends a ``PackedInt32Array`` at the end of this array. + +---- + +.. _class_PackedInt32Array_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedInt32Array_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** + +Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedInt32Array_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedInt32Array_method_push_back: + +- void **push_back** **(** :ref:`int` integer **)** + +Appends a value to the array. + +---- + +.. _class_PackedInt32Array_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedInt32Array_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedInt32Array_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** + +Changes the integer at the given index. + +---- + +.. _class_PackedInt32Array_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the array size. + diff --git a/classes/class_poolvector2array.rst b/classes/class_packedint64array.rst similarity index 60% rename from classes/class_poolvector2array.rst rename to classes/class_packedint64array.rst index 507dfdcbd..c0edbc982 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_packedint64array.rst @@ -1,78 +1,80 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolVector2Array.xml source instead. +.. DO NOT EDIT THIS FILE, but the PackedInt64Array.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_PoolVector2Array: +.. _class_PackedInt64Array: -PoolVector2Array +PackedInt64Array ================ -A pooled :ref:`Array` of :ref:`Vector2`. +A packed :ref:`Array` of 64-bit integers. Description ----------- -An :ref:`Array` specifically designed to hold :ref:`Vector2`. Optimized for memory usage, does not fragment the memory. +An :ref:`Array` specifically designed to hold 64-bit integer values. Packs data tightly, so it saves memory for large array sizes. **Note:** This type is passed by value and not by reference. +**Note:** This type stores signed 64-bit integers, which means it can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854775808, 9223372036854775807]``. Exceeding those bounds will wrap around. If you only need to pack 32-bit integers tightly, see :ref:`PackedInt32Array` for a more memory-friendly alternative. + Methods ------- +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | +| :ref:`PackedInt64Array` | :ref:`PackedInt64Array` **(** :ref:`Array` from **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | +| void | :ref:`append` **(** :ref:`int` integer **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | +| void | :ref:`append_array` **(** :ref:`PackedInt64Array` array **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | +| :ref:`bool` | :ref:`empty` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | +| void | :ref:`invert` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | +| void | :ref:`push_back` **(** :ref:`int` integer **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | +| void | :ref:`remove` **(** :ref:`int` idx **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | +| void | :ref:`resize` **(** :ref:`int` idx **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | +| :ref:`int` | :ref:`size` **(** **)** | +-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_PoolVector2Array_method_PoolVector2Array: +.. _class_PackedInt64Array_method_PackedInt64Array: -- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** +- :ref:`PackedInt64Array` **PackedInt64Array** **(** :ref:`Array` from **)** -Constructs a new ``PoolVector2Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. +Constructs a new ``PackedInt64Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. ---- -.. _class_PoolVector2Array_method_append: +.. _class_PackedInt64Array_method_append: -- void **append** **(** :ref:`Vector2` vector2 **)** +- void **append** **(** :ref:`int` integer **)** -Appends an element at the end of the array (alias of :ref:`push_back`). +Appends an element at the end of the array (alias of :ref:`push_back`). ---- -.. _class_PoolVector2Array_method_append_array: +.. _class_PackedInt64Array_method_append_array: -- void **append_array** **(** :ref:`PoolVector2Array` array **)** +- void **append_array** **(** :ref:`PackedInt64Array` array **)** -Appends a ``PoolVector2Array`` at the end of this array. +Appends a ``PackedInt64Array`` at the end of this array. ---- -.. _class_PoolVector2Array_method_empty: +.. _class_PackedInt64Array_method_empty: - :ref:`bool` **empty** **(** **)** @@ -80,15 +82,15 @@ Returns ``true`` if the array is empty. ---- -.. _class_PoolVector2Array_method_insert: +.. _class_PackedInt64Array_method_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** -Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). +Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). ---- -.. _class_PoolVector2Array_method_invert: +.. _class_PackedInt64Array_method_invert: - void **invert** **(** **)** @@ -96,15 +98,15 @@ Reverses the order of the elements in the array. ---- -.. _class_PoolVector2Array_method_push_back: +.. _class_PackedInt64Array_method_push_back: -- void **push_back** **(** :ref:`Vector2` vector2 **)** +- void **push_back** **(** :ref:`int` integer **)** -Inserts a :ref:`Vector2` at the end. +Appends a value to the array. ---- -.. _class_PoolVector2Array_method_remove: +.. _class_PackedInt64Array_method_remove: - void **remove** **(** :ref:`int` idx **)** @@ -112,7 +114,7 @@ Removes an element from the array by index. ---- -.. _class_PoolVector2Array_method_resize: +.. _class_PackedInt64Array_method_resize: - void **resize** **(** :ref:`int` idx **)** @@ -120,17 +122,17 @@ Sets the size of the array. If the array is grown, reserves elements at the end ---- -.. _class_PoolVector2Array_method_set: +.. _class_PackedInt64Array_method_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** -Changes the :ref:`Vector2` at the given index. +Changes the integer at the given index. ---- -.. _class_PoolVector2Array_method_size: +.. _class_PackedInt64Array_method_size: - :ref:`int` **size** **(** **)** -Returns the size of the array. +Returns the array size. diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index adcbfae0e..329bac821 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -47,9 +47,9 @@ Can be used to save a node to a file. When saving, the node as well as all the n Properties ---------- -+-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`_bundled` | ``{"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2}`` | -+-------------------------------------+------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`_bundled` | ``{"conn_count": 0,"conns": PackedInt32Array( ),"editable_instances": [ ],"names": PackedStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PackedInt32Array( ),"variants": [ ],"version": 2}`` | ++-------------------------------------+------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- @@ -94,9 +94,9 @@ Property Descriptions - :ref:`Dictionary` **_bundled** -+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Default* | ``{"conn_count": 0,"conns": PoolIntArray( ),"editable_instances": [ ],"names": PoolStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PoolIntArray( ),"variants": [ ],"version": 2}`` | -+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| *Default* | ``{"conn_count": 0,"conns": PackedInt32Array( ),"editable_instances": [ ],"names": PackedStringArray( ),"node_count": 0,"node_paths": [ ],"nodes": PackedInt32Array( ),"variants": [ ],"version": 2}`` | ++-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ A dictionary representation of the scene contents. diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst new file mode 100644 index 000000000..a1892cd11 --- /dev/null +++ b/classes/class_packedstringarray.rst @@ -0,0 +1,136 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedStringArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedStringArray: + +PackedStringArray +================= + +A packed :ref:`Array` of :ref:`String`\ s. + +Description +----------- + +An :ref:`Array` specifically designed to hold :ref:`String`\ s. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +Methods +------- + ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`PackedStringArray` **(** :ref:`Array` from **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedStringArray` array **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedStringArray_method_PackedStringArray: + +- :ref:`PackedStringArray` **PackedStringArray** **(** :ref:`Array` from **)** + +Constructs a new ``PackedStringArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedStringArray_method_append: + +- void **append** **(** :ref:`String` string **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedStringArray_method_append_array: + +- void **append_array** **(** :ref:`PackedStringArray` array **)** + +Appends a ``PackedStringArray`` at the end of this array. + +---- + +.. _class_PackedStringArray_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedStringArray_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedStringArray_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedStringArray_method_push_back: + +- void **push_back** **(** :ref:`String` string **)** + +Appends a string element at end of the array. + +---- + +.. _class_PackedStringArray_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedStringArray_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedStringArray_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`String` string **)** + +Changes the :ref:`String` at the given index. + +---- + +.. _class_PackedStringArray_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst new file mode 100644 index 000000000..12cb87dbe --- /dev/null +++ b/classes/class_packedvector2array.rst @@ -0,0 +1,136 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedVector2Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedVector2Array: + +PackedVector2Array +================== + +A packed :ref:`Array` of :ref:`Vector2`\ s. + +Description +----------- + +An :ref:`Array` specifically designed to hold :ref:`Vector2`. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +Methods +------- + ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`PackedVector2Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedVector2Array` array **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedVector2Array_method_PackedVector2Array: + +- :ref:`PackedVector2Array` **PackedVector2Array** **(** :ref:`Array` from **)** + +Constructs a new ``PackedVector2Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedVector2Array_method_append: + +- void **append** **(** :ref:`Vector2` vector2 **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedVector2Array_method_append_array: + +- void **append_array** **(** :ref:`PackedVector2Array` array **)** + +Appends a ``PackedVector2Array`` at the end of this array. + +---- + +.. _class_PackedVector2Array_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedVector2Array_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedVector2Array_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedVector2Array_method_push_back: + +- void **push_back** **(** :ref:`Vector2` vector2 **)** + +Inserts a :ref:`Vector2` at the end. + +---- + +.. _class_PackedVector2Array_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedVector2Array_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedVector2Array_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** + +Changes the :ref:`Vector2` at the given index. + +---- + +.. _class_PackedVector2Array_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst new file mode 100644 index 000000000..70fa3ca5c --- /dev/null +++ b/classes/class_packedvector3array.rst @@ -0,0 +1,136 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PackedVector3Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PackedVector3Array: + +PackedVector3Array +================== + +A packed :ref:`Array` of :ref:`Vector3`\ s. + +Description +----------- + +An :ref:`Array` specifically designed to hold :ref:`Vector3`. Packs data tightly, so it saves memory for large array sizes. + +**Note:** This type is passed by value and not by reference. + +Methods +------- + ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`PackedVector3Array` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PackedVector3Array` array **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PackedVector3Array_method_PackedVector3Array: + +- :ref:`PackedVector3Array` **PackedVector3Array** **(** :ref:`Array` from **)** + +Constructs a new ``PackedVector3Array``. Optionally, you can pass in a generic :ref:`Array` that will be converted. + +---- + +.. _class_PackedVector3Array_method_append: + +- void **append** **(** :ref:`Vector3` vector3 **)** + +Appends an element at the end of the array (alias of :ref:`push_back`). + +---- + +.. _class_PackedVector3Array_method_append_array: + +- void **append_array** **(** :ref:`PackedVector3Array` array **)** + +Appends a ``PackedVector3Array`` at the end of this array. + +---- + +.. _class_PackedVector3Array_method_empty: + +- :ref:`bool` **empty** **(** **)** + +Returns ``true`` if the array is empty. + +---- + +.. _class_PackedVector3Array_method_insert: + +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** + +Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). + +---- + +.. _class_PackedVector3Array_method_invert: + +- void **invert** **(** **)** + +Reverses the order of the elements in the array. + +---- + +.. _class_PackedVector3Array_method_push_back: + +- void **push_back** **(** :ref:`Vector3` vector3 **)** + +Inserts a :ref:`Vector3` at the end. + +---- + +.. _class_PackedVector3Array_method_remove: + +- void **remove** **(** :ref:`int` idx **)** + +Removes an element from the array by index. + +---- + +.. _class_PackedVector3Array_method_resize: + +- void **resize** **(** :ref:`int` idx **)** + +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. + +---- + +.. _class_PackedVector3Array_method_set: + +- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** + +Changes the :ref:`Vector3` at the given index. + +---- + +.. _class_PackedVector3Array_method_size: + +- :ref:`int` **size** **(** **)** + +Returns the size of the array. + diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 233c188fe..aa5b7f2d7 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -11,7 +11,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebRTCDataChannel`, :ref:`WebSocketPeer` +**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerDTLS`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebRTCDataChannel`, :ref:`WebSocketPeer` Abstraction and base class for packet-based protocols. @@ -23,52 +23,30 @@ PacketPeer is an abstraction and base class for packet-based protocols (such as Properties ---------- -+-------------------------+---------------------------------------------------------------------------------+-------------+ -| :ref:`bool` | :ref:`allow_object_decoding` | ``false`` | -+-------------------------+---------------------------------------------------------------------------------+-------------+ -| :ref:`int` | :ref:`encode_buffer_max_size` | ``8388608`` | -+-------------------------+---------------------------------------------------------------------------------+-------------+ ++-----------------------+---------------------------------------------------------------------------------+-------------+ +| :ref:`int` | :ref:`encode_buffer_max_size` | ``8388608`` | ++-----------------------+---------------------------------------------------------------------------------+-------------+ Methods ------- -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`get_packet` **(** **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_packet` **(** :ref:`PackedByteArray` buffer **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | ++-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_PacketPeer_property_allow_object_decoding: - -- :ref:`bool` **allow_object_decoding** - -+-----------+----------------------------------+ -| *Default* | ``false`` | -+-----------+----------------------------------+ -| *Setter* | set_allow_object_decoding(value) | -+-----------+----------------------------------+ -| *Getter* | is_object_decoding_allowed() | -+-----------+----------------------------------+ - -*Deprecated.* Use ``get_var`` and ``put_var`` parameters instead. - -If ``true``, the PacketPeer will allow encoding and decoding of object via :ref:`get_var` and :ref:`put_var`. - -**Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - ----- - .. _class_PacketPeer_property_encode_buffer_max_size: - :ref:`int` **encode_buffer_max_size** @@ -98,7 +76,7 @@ Returns the number of packets currently available in the ring-buffer. .. _class_PacketPeer_method_get_packet: -- :ref:`PoolByteArray` **get_packet** **(** **)** +- :ref:`PackedByteArray` **get_packet** **(** **)** Gets a raw packet. @@ -116,7 +94,7 @@ Returns the error state of the last packet received (via :ref:`get_packet` **get_var** **(** :ref:`bool` allow_objects=false **)** -Gets a Variant. If ``allow_objects`` (or :ref:`allow_object_decoding`) is ``true``, decoding objects is allowed. +Gets a Variant. If ``allow_objects`` is ``true``, decoding objects is allowed. **Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -124,7 +102,7 @@ Gets a Variant. If ``allow_objects`` (or :ref:`allow_object_decoding` **put_packet** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **put_packet** **(** :ref:`PackedByteArray` buffer **)** Sends a raw packet. @@ -134,5 +112,5 @@ Sends a raw packet. - :ref:`Error` **put_var** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** -Sends a :ref:`Variant` as a packet. If ``full_objects`` (or :ref:`allow_object_decoding`) is ``true``, encoding objects is allowed (and can potentially include code). +Sends a :ref:`Variant` as a packet. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code). diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst new file mode 100644 index 000000000..666893255 --- /dev/null +++ b/classes/class_packetpeerdtls.rst @@ -0,0 +1,93 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the PacketPeerDTLS.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_PacketPeerDTLS: + +PacketPeerDTLS +============== + +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +DTLS packet peer. + +Description +----------- + +This class represents a DTLS peer connection. It can be used to connect to a DTLS server, and is returned by :ref:`DTLSServer.take_connection`. + +Methods +------- + ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_peer` **(** :ref:`PacketPeerUDP` packet_peer, :ref:`bool` validate_certs=true, :ref:`String` for_hostname="", :ref:`X509Certificate` valid_certificate=null **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_peer` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Status` | :ref:`get_status` **(** **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`poll` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_PacketPeerDTLS_Status: + +.. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED: + +.. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING: + +.. _class_PacketPeerDTLS_constant_STATUS_CONNECTED: + +.. _class_PacketPeerDTLS_constant_STATUS_ERROR: + +.. _class_PacketPeerDTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH: + +enum **Status**: + +- **STATUS_DISCONNECTED** = **0** --- A status representing a ``PacketPeerDTLS`` that is disconnected. + +- **STATUS_HANDSHAKING** = **1** --- A status representing a ``PacketPeerDTLS`` that is currently performing the handshake with a remote peer. + +- **STATUS_CONNECTED** = **2** --- A status representing a ``PacketPeerDTLS`` that is connected to a remote peer. + +- **STATUS_ERROR** = **3** --- A status representing a ``PacketPeerDTLS`` in a generic error state. + +- **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the DTLS certificate domain presented by the host and the domain requested for validation. + +Method Descriptions +------------------- + +.. _class_PacketPeerDTLS_method_connect_to_peer: + +- :ref:`Error` **connect_to_peer** **(** :ref:`PacketPeerUDP` packet_peer, :ref:`bool` validate_certs=true, :ref:`String` for_hostname="", :ref:`X509Certificate` valid_certificate=null **)** + +Connects a ``peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP` which must be connected (see :ref:`PacketPeerUDP.connect_to_host`). If ``validate_certs`` is ``true``, ``PacketPeerDTLS`` will validate that the certificate presented by the remote peer and match it with the ``for_hostname`` argument. You can specify a custom :ref:`X509Certificate` to use for validation via the ``valid_certificate`` argument. + +---- + +.. _class_PacketPeerDTLS_method_disconnect_from_peer: + +- void **disconnect_from_peer** **(** **)** + +Disconnects this peer, terminating the DTLS session. + +---- + +.. _class_PacketPeerDTLS_method_get_status: + +- :ref:`Status` **get_status** **(** **)** const + +Returns the status of the connection. See :ref:`Status` for values. + +---- + +.. _class_PacketPeerDTLS_method_poll: + +- void **poll** **(** **)** + +Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working. + diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 42adf3205..6bd9a3135 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -24,10 +24,14 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_packet_ip` **(** **)** const | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_port` **(** **)** const | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_listening` **(** **)** const | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`join_multicast_group` **(** :ref:`String` multicast_address, :ref:`String` interface_name **)** | @@ -54,6 +58,16 @@ Closes the UDP socket the ``PacketPeerUDP`` is currently listening on. ---- +.. _class_PacketPeerUDP_method_connect_to_host: + +- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** + +Calling this method connects this UDP peer to the given ``host``/``port`` pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to :ref:`set_dest_address` are not allowed). This method does not send any data to the remote peer, to do that, use :ref:`PacketPeer.put_var` or :ref:`PacketPeer.put_packet` as usual. See also :ref:`UDPServer`. + +Note: Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. + +---- + .. _class_PacketPeerUDP_method_get_packet_ip: - :ref:`String` **get_packet_ip** **(** **)** const @@ -70,6 +84,14 @@ Returns the port of the remote peer that sent the last packet(that was received ---- +.. _class_PacketPeerUDP_method_is_connected_to_host: + +- :ref:`bool` **is_connected_to_host** **(** **)** const + +Returns ``true`` if the UDP socket is open and has been connected to a remote address. See :ref:`connect_to_host`. + +---- + .. _class_PacketPeerUDP_method_is_listening: - :ref:`bool` **is_listening** **(** **)** const diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index f005517b6..687a9fd4d 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -20,6 +20,13 @@ Description Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline. +Properties +---------- + ++----------------------------------------------+--------------+--------------+ +| :ref:`MouseFilter` | mouse_filter | **O:** ``0`` | ++----------------------------------------------+--------------+--------------+ + Theme Properties ---------------- diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 474c736e3..7892ad069 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -18,19 +18,23 @@ Description A resource referenced in an :ref:`Environment` that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a cube map. +Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR (``.hdr``) and OpenEXR (``.exr``) image formats for this purpose. + +You can use `this tool `_ to convert a cube map to an equirectangular sky map. + Properties ---------- -+-------------------------------+------------------------------------------------------+ -| :ref:`Texture` | :ref:`panorama` | -+-------------------------------+------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`panorama` | ++-----------------------------------+------------------------------------------------------+ Property Descriptions --------------------- .. _class_PanoramaSky_property_panorama: -- :ref:`Texture` **panorama** +- :ref:`Texture2D` **panorama** +----------+---------------------+ | *Setter* | set_panorama(value) | @@ -38,5 +42,5 @@ Property Descriptions | *Getter* | get_panorama() | +----------+---------------------+ -:ref:`Texture` to be applied to the PanoramaSky. +:ref:`Texture2D` to be applied to the PanoramaSky. diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 002b051fa..33cd536f9 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -48,7 +48,7 @@ Property Descriptions | *Getter* | get_mirroring() | +-----------+----------------------+ -The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture` will not be mirrored. +The ParallaxLayer's :ref:`Texture2D` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture2D` will not be mirrored. ---- diff --git a/classes/class_particles.rst b/classes/class_particles.rst index ea92e9b71..910f04f80 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -43,7 +43,7 @@ Properties +--------------------------------------------+--------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`draw_passes` | ``1`` | +--------------------------------------------+--------------------------------------------------------------------+---------------------------------+ -| :ref:`bool` | :ref:`emitting` | ``true`` | +| :ref:`bool` | :ref:`emitting` | ``false`` | +--------------------------------------------+--------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`explosiveness` | ``0.0`` | +--------------------------------------------+--------------------------------------------------------------------+---------------------------------+ @@ -219,7 +219,7 @@ The number of draw passes when rendering particles. - :ref:`bool` **emitting** +-----------+---------------------+ -| *Default* | ``true`` | +| *Default* | ``false`` | +-----------+---------------------+ | *Setter* | set_emitting(value) | +-----------+---------------------+ diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index cec631baa..78952229a 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -33,7 +33,7 @@ Properties +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ -| :ref:`bool` | :ref:`emitting` | ``true`` | +| :ref:`bool` | :ref:`emitting` | ``false`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`explosiveness` | ``0.0`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ @@ -45,7 +45,7 @@ Properties +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`local_coords` | ``true`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ -| :ref:`Texture` | :ref:`normal_map` | | +| :ref:`Texture2D` | :ref:`normal_map` | | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`one_shot` | ``false`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ @@ -57,7 +57,7 @@ Properties +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ | :ref:`Rect2` | :ref:`visibility_rect` | ``Rect2( -100, -100, 200, 200 )`` | +----------------------------------------------+----------------------------------------------------------------------+-----------------------------------+ @@ -126,7 +126,7 @@ Particle draw order. Uses :ref:`DrawOrder` values. - :ref:`bool` **emitting** +-----------+---------------------+ -| *Default* | ``true`` | +| *Default* | ``false`` | +-----------+---------------------+ | *Setter* | set_emitting(value) | +-----------+---------------------+ @@ -219,7 +219,7 @@ If ``true``, particles use the parent node's coordinate space. If ``false``, the .. _class_Particles2D_property_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture2D` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | @@ -311,7 +311,7 @@ Particle system's running speed scaling ratio. A value of ``0`` can be used to p .. _class_Particles2D_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index cf5f84469..c3dc57e04 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -28,35 +28,35 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angle` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`angle_curve` | | +| :ref:`Texture2D` | :ref:`angle_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angle_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angular_velocity` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`angular_velocity_curve` | | +| :ref:`Texture2D` | :ref:`angular_velocity_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`angular_velocity_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_offset` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`anim_offset_curve` | | +| :ref:`Texture2D` | :ref:`anim_offset_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_offset_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_speed` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`anim_speed_curve` | | +| :ref:`Texture2D` | :ref:`anim_speed_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`anim_speed_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`color_ramp` | | +| :ref:`Texture2D` | :ref:`color_ramp` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`damping` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`damping_curve` | | +| :ref:`Texture2D` | :ref:`damping_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`damping_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ @@ -64,13 +64,13 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`Vector3` | :ref:`emission_box_extents` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`emission_color_texture` | | +| :ref:`Texture2D` | :ref:`emission_color_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`emission_normal_texture` | | +| :ref:`Texture2D` | :ref:`emission_normal_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`int` | :ref:`emission_point_count` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`emission_point_texture` | | +| :ref:`Texture2D` | :ref:`emission_point_texture` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ @@ -88,7 +88,7 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`hue_variation` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`hue_variation_curve` | | +| :ref:`Texture2D` | :ref:`hue_variation_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`hue_variation_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ @@ -100,25 +100,25 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`linear_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`linear_accel_curve` | | +| :ref:`Texture2D` | :ref:`linear_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`linear_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`orbit_velocity` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`orbit_velocity_curve` | | +| :ref:`Texture2D` | :ref:`orbit_velocity_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`orbit_velocity_random` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`radial_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`radial_accel_curve` | | +| :ref:`Texture2D` | :ref:`radial_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`radial_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`scale` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`scale_curve` | | +| :ref:`Texture2D` | :ref:`scale_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`scale_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ @@ -126,7 +126,7 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`tangential_accel` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ -| :ref:`Texture` | :ref:`tangential_accel_curve` | | +| :ref:`Texture2D` | :ref:`tangential_accel_curve` | | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ | :ref:`float` | :ref:`tangential_accel_random` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------+ @@ -140,23 +140,23 @@ Properties Methods ------- -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** const | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`Parameter` param, :ref:`float` value **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_randomness` **(** :ref:`Parameter` param, :ref:`float` randomness **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param_texture` **(** :ref:`Parameter` param, :ref:`Texture` texture **)** | -+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_flag` **(** :ref:`Flags` flag **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param` **(** :ref:`Parameter` param **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_param_randomness` **(** :ref:`Parameter` param **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_param_texture` **(** :ref:`Parameter` param **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flag` **(** :ref:`Flags` flag, :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param` **(** :ref:`Parameter` param, :ref:`float` value **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_randomness` **(** :ref:`Parameter` param, :ref:`float` randomness **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_param_texture` **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -286,13 +286,13 @@ Property Descriptions Initial rotation applied to each particle, in degrees. -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`. +Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`BaseMaterial3D` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES`. ---- .. _class_ParticlesMaterial_property_angle_curve: -- :ref:`Texture` **angle_curve** +- :ref:`Texture2D` **angle_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -334,13 +334,13 @@ Rotation randomness ratio. Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. -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`. +Only applied when :ref:`flag_disable_z` or :ref:`flag_rotate_y` are ``true`` or the :ref:`BaseMaterial3D` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES`. ---- .. _class_ParticlesMaterial_property_angular_velocity_curve: -- :ref:`Texture` **angular_velocity_curve** +- :ref:`Texture2D` **angular_velocity_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -386,7 +386,7 @@ Particle animation offset. .. _class_ParticlesMaterial_property_anim_offset_curve: -- :ref:`Texture` **anim_offset_curve** +- :ref:`Texture2D` **anim_offset_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -432,7 +432,7 @@ Particle animation speed. .. _class_ParticlesMaterial_property_anim_speed_curve: -- :ref:`Texture` **anim_speed_curve** +- :ref:`Texture2D` **anim_speed_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -472,13 +472,13 @@ Animation speed randomness ratio. | *Getter* | 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 ``texture`` is defined, it will be multiplied by this color. To have particle display color in a :ref:`BaseMaterial3D` make sure to set :ref:`BaseMaterial3D.vertex_color_use_as_albedo` to ``true``. ---- .. _class_ParticlesMaterial_property_color_ramp: -- :ref:`Texture` **color_ramp** +- :ref:`Texture2D` **color_ramp** +----------+-----------------------+ | *Setter* | set_color_ramp(value) | @@ -508,7 +508,7 @@ The rate at which particles lose velocity. .. _class_ParticlesMaterial_property_damping_curve: -- :ref:`Texture` **damping_curve** +- :ref:`Texture2D` **damping_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -568,7 +568,7 @@ The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX` **emission_color_texture** +- :ref:`Texture2D` **emission_color_texture** +----------+-----------------------------------+ | *Setter* | set_emission_color_texture(value) | @@ -582,7 +582,7 @@ Particle color will be modulated by color determined by sampling this texture at .. _class_ParticlesMaterial_property_emission_normal_texture: -- :ref:`Texture` **emission_normal_texture** +- :ref:`Texture2D` **emission_normal_texture** +----------+------------------------------------+ | *Setter* | set_emission_normal_texture(value) | @@ -610,7 +610,7 @@ The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHA .. _class_ParticlesMaterial_property_emission_point_texture: -- :ref:`Texture` **emission_point_texture** +- :ref:`Texture2D` **emission_point_texture** +----------+-----------------------------------+ | *Setter* | set_emission_point_texture(value) | @@ -750,7 +750,7 @@ Initial hue variation applied to each particle. .. _class_ParticlesMaterial_property_hue_variation_curve: -- :ref:`Texture` **hue_variation_curve** +- :ref:`Texture2D` **hue_variation_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -844,7 +844,7 @@ Linear acceleration applied to each particle in the direction of motion. .. _class_ParticlesMaterial_property_linear_accel_curve: -- :ref:`Texture` **linear_accel_curve** +- :ref:`Texture2D` **linear_accel_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -890,7 +890,7 @@ Only available when :ref:`flag_disable_z` **orbit_velocity_curve** +- :ref:`Texture2D` **orbit_velocity_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -934,7 +934,7 @@ Radial acceleration applied to each particle. Makes particle accelerate away fro .. _class_ParticlesMaterial_property_radial_accel_curve: -- :ref:`Texture` **radial_accel_curve** +- :ref:`Texture2D` **radial_accel_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -980,7 +980,7 @@ Initial scale applied to each particle. .. _class_ParticlesMaterial_property_scale_curve: -- :ref:`Texture` **scale_curve** +- :ref:`Texture2D` **scale_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -1042,7 +1042,7 @@ Tangential acceleration applied to each particle. Tangential acceleration is per .. _class_ParticlesMaterial_property_tangential_accel_curve: -- :ref:`Texture` **tangential_accel_curve** +- :ref:`Texture2D` **tangential_accel_curve** +----------+--------------------------+ | *Setter* | set_param_texture(value) | @@ -1141,9 +1141,9 @@ Returns the randomness ratio associated with the specified parameter. .. _class_ParticlesMaterial_method_get_param_texture: -- :ref:`Texture` **get_param_texture** **(** :ref:`Parameter` param **)** const +- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** const -Returns the :ref:`Texture` used by the specified parameter. +Returns the :ref:`Texture2D` used by the specified parameter. ---- @@ -1173,7 +1173,7 @@ Sets the randomness ratio for the specified :ref:`Parameter` param, :ref:`Texture` texture **)** +- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** -Sets the :ref:`Texture` for the specified :ref:`Parameter`. +Sets the :ref:`Texture2D` for the specified :ref:`Parameter`. diff --git a/classes/class_performance.rst b/classes/class_performance.rst index fa308eeaf..bbce4e77e 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -42,12 +42,8 @@ Enumerations .. _class_Performance_constant_MEMORY_STATIC: -.. _class_Performance_constant_MEMORY_DYNAMIC: - .. _class_Performance_constant_MEMORY_STATIC_MAX: -.. _class_Performance_constant_MEMORY_DYNAMIC_MAX: - .. _class_Performance_constant_MEMORY_MESSAGE_BUFFER_MAX: .. _class_Performance_constant_OBJECT_COUNT: @@ -104,57 +100,53 @@ enum **Monitor**: - **MEMORY_STATIC** = **3** --- Static memory currently used, in bytes. Not available in release builds. -- **MEMORY_DYNAMIC** = **4** --- Dynamic memory currently used, in bytes. Not available in release builds. +- **MEMORY_STATIC_MAX** = **4** --- Available static memory. Not available in release builds. -- **MEMORY_STATIC_MAX** = **5** --- Available static memory. Not available in release builds. +- **MEMORY_MESSAGE_BUFFER_MAX** = **5** --- Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications. -- **MEMORY_DYNAMIC_MAX** = **6** --- Available dynamic memory. Not available in release builds. +- **OBJECT_COUNT** = **6** --- Number of objects currently instanced (including nodes). -- **MEMORY_MESSAGE_BUFFER_MAX** = **7** --- Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications. +- **OBJECT_RESOURCE_COUNT** = **7** --- Number of resources currently used. -- **OBJECT_COUNT** = **8** --- Number of objects currently instanced (including nodes). +- **OBJECT_NODE_COUNT** = **8** --- Number of nodes currently instanced in the scene tree. This also includes the root node. -- **OBJECT_RESOURCE_COUNT** = **9** --- Number of resources currently used. +- **OBJECT_ORPHAN_NODE_COUNT** = **9** --- Number of orphan nodes, i.e. nodes which are not parented to a node of the scene tree. -- **OBJECT_NODE_COUNT** = **10** --- Number of nodes currently instanced in the scene tree. This also includes the root node. +- **RENDER_OBJECTS_IN_FRAME** = **10** --- 3D objects drawn per frame. -- **OBJECT_ORPHAN_NODE_COUNT** = **11** --- Number of orphan nodes, i.e. nodes which are not parented to a node of the scene tree. +- **RENDER_VERTICES_IN_FRAME** = **11** --- Vertices drawn per frame. 3D only. -- **RENDER_OBJECTS_IN_FRAME** = **12** --- 3D objects drawn per frame. +- **RENDER_MATERIAL_CHANGES_IN_FRAME** = **12** --- Material changes per frame. 3D only. -- **RENDER_VERTICES_IN_FRAME** = **13** --- Vertices drawn per frame. 3D only. +- **RENDER_SHADER_CHANGES_IN_FRAME** = **13** --- Shader changes per frame. 3D only. -- **RENDER_MATERIAL_CHANGES_IN_FRAME** = **14** --- Material changes per frame. 3D only. +- **RENDER_SURFACE_CHANGES_IN_FRAME** = **14** --- Render surface changes per frame. 3D only. -- **RENDER_SHADER_CHANGES_IN_FRAME** = **15** --- Shader changes per frame. 3D only. +- **RENDER_DRAW_CALLS_IN_FRAME** = **15** --- Draw calls per frame. 3D only. -- **RENDER_SURFACE_CHANGES_IN_FRAME** = **16** --- Render surface changes per frame. 3D only. +- **RENDER_VIDEO_MEM_USED** = **16** --- The amount of video memory used, i.e. texture and vertex memory combined. -- **RENDER_DRAW_CALLS_IN_FRAME** = **17** --- Draw calls per frame. 3D only. +- **RENDER_TEXTURE_MEM_USED** = **17** --- The amount of texture memory used. -- **RENDER_VIDEO_MEM_USED** = **18** --- The amount of video memory used, i.e. texture and vertex memory combined. +- **RENDER_VERTEX_MEM_USED** = **18** --- The amount of vertex memory used. -- **RENDER_TEXTURE_MEM_USED** = **19** --- The amount of texture memory used. +- **RENDER_USAGE_VIDEO_MEM_TOTAL** = **19** --- Unimplemented in the GLES2 rendering backend, always returns 0. -- **RENDER_VERTEX_MEM_USED** = **20** --- The amount of vertex memory used. +- **PHYSICS_2D_ACTIVE_OBJECTS** = **20** --- Number of active :ref:`RigidBody2D` nodes in the game. -- **RENDER_USAGE_VIDEO_MEM_TOTAL** = **21** --- Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. +- **PHYSICS_2D_COLLISION_PAIRS** = **21** --- Number of collision pairs in the 2D physics engine. -- **PHYSICS_2D_ACTIVE_OBJECTS** = **22** --- Number of active :ref:`RigidBody2D` nodes in the game. +- **PHYSICS_2D_ISLAND_COUNT** = **22** --- Number of islands in the 2D physics engine. -- **PHYSICS_2D_COLLISION_PAIRS** = **23** --- Number of collision pairs in the 2D physics engine. +- **PHYSICS_3D_ACTIVE_OBJECTS** = **23** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. -- **PHYSICS_2D_ISLAND_COUNT** = **24** --- Number of islands in the 2D physics engine. +- **PHYSICS_3D_COLLISION_PAIRS** = **24** --- Number of collision pairs in the 3D physics engine. -- **PHYSICS_3D_ACTIVE_OBJECTS** = **25** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. +- **PHYSICS_3D_ISLAND_COUNT** = **25** --- Number of islands in the 3D physics engine. -- **PHYSICS_3D_COLLISION_PAIRS** = **26** --- Number of collision pairs in the 3D physics engine. +- **AUDIO_OUTPUT_LATENCY** = **26** --- Output latency of the :ref:`AudioServer`. -- **PHYSICS_3D_ISLAND_COUNT** = **27** --- Number of islands in the 3D physics engine. - -- **AUDIO_OUTPUT_LATENCY** = **28** --- Output latency of the :ref:`AudioServer`. - -- **MONITOR_MAX** = **29** --- Represents the size of the :ref:`Monitor` enum. +- **MONITOR_MAX** = **27** --- Represents the size of the :ref:`Monitor` enum. Method Descriptions ------------------- diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index f5cc8ccc1..ee57558e1 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -48,8 +48,6 @@ Methods +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_simulating_physics` **(** **)** | +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_static_body` **(** **)** | -+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -226,9 +224,3 @@ Method Descriptions - :ref:`bool` **is_simulating_physics** **(** **)** ----- - -.. _class_PhysicalBone_method_is_static_body: - -- :ref:`bool` **is_static_body** **(** **)** - diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index a1baf0fcd..7c6061b53 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -54,13 +54,13 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,7 +146,7 @@ Methods +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -685,7 +685,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. _class_Physics2DServer_method_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** ---- @@ -707,7 +707,7 @@ Sets which physics layers the area will monitor. .. _class_Physics2DServer_method_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -1049,7 +1049,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_Physics2DServer_method_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 18cb9095f..bdab8f209 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -23,233 +23,233 @@ PhysicsServer is the server responsible for all 3D physics. It can create many k Methods ------- -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), :ref:`bool` disabled=false **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), :ref:`bool` disabled=false **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | -+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), :ref:`bool` disabled=false **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_create` **(** **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ), :ref:`bool` disabled=false **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_create` **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`space_create` **(** **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | ++------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -468,7 +468,7 @@ enum **ConeTwistJointParam**: - **CONE_TWIST_JOINT_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. -The swing span defines, how much rotation will not get corrected allong the swing axis. +The swing span defines, how much rotation will not get corrected along the swing axis. Could be defined as looseness in the :ref:`ConeTwistJoint`. @@ -604,7 +604,7 @@ enum **G6DOFJointAxisFlag**: enum **ShapeType**: -- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. +- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`WorldMarginShape`. - **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. @@ -991,7 +991,7 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig .. _class_PhysicsServer_method_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** ---- @@ -1013,7 +1013,7 @@ Sets which physics layers the area will monitor. .. _class_PhysicsServer_method_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`StringName` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: @@ -1371,7 +1371,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_PhysicsServer_method_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`StringName` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 28c7fa1c0..fa9010b4f 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -113,9 +113,13 @@ Method Descriptions - :ref:`float` **get_param** **(** :ref:`Param` param **)** const +Returns the value of the specified parameter. + ---- .. _class_PinJoint_method_set_param: - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +Sets the value of the specified parameter. + diff --git a/classes/class_plane.rst b/classes/class_plane.rst index b80d1c1dd..c7016a5bb 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -52,7 +52,7 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_any_point` **(** **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=1e-05 **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -194,7 +194,7 @@ Returns a point on the plane. .. _class_Plane_method_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** +- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=1e-05 **)** Returns ``true`` if ``point`` is inside the plane (by a very minimum ``epsilon`` threshold). diff --git a/classes/class_pointmesh.rst b/classes/class_pointmesh.rst index 1dc91b484..03569131b 100644 --- a/classes/class_pointmesh.rst +++ b/classes/class_pointmesh.rst @@ -18,7 +18,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:`BaseMaterial3D` by setting :ref:`BaseMaterial3D.use_point_size` and the variable :ref:`BaseMaterial3D.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 084c0c756..aa187bc61 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -18,67 +18,73 @@ Description A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture. -**Note:** By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb` and :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb`. - Properties ---------- -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`antialiased` | ``false`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Array` | :ref:`bones` | ``[ ]`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`int` | :ref:`internal_vertex_count` | ``0`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`float` | :ref:`invert_border` | ``100.0`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`bool` | :ref:`invert_enable` | ``false`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Array` | :ref:`polygons` | ``[ ]`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`NodePath` | :ref:`skeleton` | ``NodePath("")`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture` | :ref:`texture` | | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Vector2` | :ref:`texture_offset` | ``Vector2( 0, 0 )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`float` | :ref:`texture_rotation` | | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`float` | :ref:`texture_rotation_degrees` | ``0.0`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`Vector2` | :ref:`texture_scale` | ``Vector2( 1, 1 )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`PoolVector2Array` | :ref:`uv` | ``PoolVector2Array( )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ -| :ref:`PoolColorArray` | :ref:`vertex_colors` | ``PoolColorArray( )`` | -+-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`antialiased` | ``false`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Array` | :ref:`bones` | ``[ ]`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`int` | :ref:`internal_vertex_count` | ``0`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`invert_border` | ``100.0`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`bool` | :ref:`invert_enable` | ``false`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Texture2D` | :ref:`normal_map` | | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`polygon` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Array` | :ref:`polygons` | ``[ ]`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`shininess` | ``1.0`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`NodePath` | :ref:`skeleton` | ``NodePath("")`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Color` | :ref:`specular_color` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Texture2D` | :ref:`specular_map` | | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Texture2D` | :ref:`texture` | | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector2` | :ref:`texture_offset` | ``Vector2( 0, 0 )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`texture_rotation` | | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`texture_rotation_degrees` | ``0.0`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`Vector2` | :ref:`texture_scale` | ``Vector2( 1, 1 )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedVector2Array` | :ref:`uv` | ``PackedVector2Array( )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ +| :ref:`PackedColorArray` | :ref:`vertex_colors` | ``PackedColorArray( )`` | ++-----------------------------------------------------+------------------------------------------------------------------------------------+----------------------------+ Methods ------- -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_bones` **(** **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_bone` **(** :ref:`int` index **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bone_count` **(** **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** const | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | -+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PackedFloat32Array` weights **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_bones` **(** **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_bone` **(** :ref:`int` index **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bone_count` **(** **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`get_bone_weights` **(** :ref:`int` index **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PackedFloat32Array` weights **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -171,6 +177,18 @@ If ``true``, polygon will be inverted, containing the area outside the defined p ---- +.. _class_Polygon2D_property_normal_map: + +- :ref:`Texture2D` **normal_map** + ++----------+-----------------------+ +| *Setter* | set_normal_map(value) | ++----------+-----------------------+ +| *Getter* | get_normal_map() | ++----------+-----------------------+ + +---- + .. _class_Polygon2D_property_offset: - :ref:`Vector2` **offset** @@ -189,19 +207,19 @@ The offset applied to each vertex. .. _class_Polygon2D_property_polygon: -- :ref:`PoolVector2Array` **polygon** +- :ref:`PackedVector2Array` **polygon** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_polygon(value) | -+-----------+--------------------------+ -| *Getter* | get_polygon() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_polygon(value) | ++-----------+----------------------------+ +| *Getter* | get_polygon() | ++-----------+----------------------------+ The polygon's list of vertices. The final point will be connected to the first. -**Note:** This returns a copy of the :ref:`PoolVector2Array` rather than a reference. +**Note:** This returns a copy of the :ref:`PackedVector2Array` rather than a reference. ---- @@ -219,6 +237,20 @@ The polygon's list of vertices. The final point will be connected to the first. ---- +.. _class_Polygon2D_property_shininess: + +- :ref:`float` **shininess** + ++-----------+----------------------+ +| *Default* | ``1.0`` | ++-----------+----------------------+ +| *Setter* | set_shininess(value) | ++-----------+----------------------+ +| *Getter* | get_shininess() | ++-----------+----------------------+ + +---- + .. _class_Polygon2D_property_skeleton: - :ref:`NodePath` **skeleton** @@ -233,9 +265,35 @@ The polygon's list of vertices. The final point will be connected to the first. ---- +.. _class_Polygon2D_property_specular_color: + +- :ref:`Color` **specular_color** + ++-----------+---------------------------+ +| *Default* | ``Color( 1, 1, 1, 1 )`` | ++-----------+---------------------------+ +| *Setter* | set_specular_color(value) | ++-----------+---------------------------+ +| *Getter* | get_specular_color() | ++-----------+---------------------------+ + +---- + +.. _class_Polygon2D_property_specular_map: + +- :ref:`Texture2D` **specular_map** + ++----------+-------------------------+ +| *Setter* | set_specular_map(value) | ++----------+-------------------------+ +| *Getter* | get_specular_map() | ++----------+-------------------------+ + +---- + .. _class_Polygon2D_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -311,15 +369,15 @@ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger value .. _class_Polygon2D_property_uv: -- :ref:`PoolVector2Array` **uv** +- :ref:`PackedVector2Array` **uv** -+-----------+--------------------------+ -| *Default* | ``PoolVector2Array( )`` | -+-----------+--------------------------+ -| *Setter* | set_uv(value) | -+-----------+--------------------------+ -| *Getter* | get_uv() | -+-----------+--------------------------+ ++-----------+----------------------------+ +| *Default* | ``PackedVector2Array( )`` | ++-----------+----------------------------+ +| *Setter* | set_uv(value) | ++-----------+----------------------------+ +| *Getter* | get_uv() | ++-----------+----------------------------+ Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. @@ -327,10 +385,10 @@ Texture coordinates for each vertex of the polygon. There should be one ``uv`` p .. _class_Polygon2D_property_vertex_colors: -- :ref:`PoolColorArray` **vertex_colors** +- :ref:`PackedColorArray` **vertex_colors** +-----------+--------------------------+ -| *Default* | ``PoolColorArray( )`` | +| *Default* | ``PackedColorArray( )`` | +-----------+--------------------------+ | *Setter* | set_vertex_colors(value) | +-----------+--------------------------+ @@ -344,7 +402,9 @@ Method Descriptions .. _class_Polygon2D_method_add_bone: -- void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** +- void **add_bone** **(** :ref:`NodePath` path, :ref:`PackedFloat32Array` weights **)** + +Adds a bone with the specified ``path`` and ``weights``. ---- @@ -352,29 +412,39 @@ Method Descriptions - void **clear_bones** **(** **)** +Removes all bones from this ``Polygon2D``. + ---- .. _class_Polygon2D_method_erase_bone: - void **erase_bone** **(** :ref:`int` index **)** +Removes the specified bone from this ``Polygon2D``. + ---- .. _class_Polygon2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const +Returns the number of bones in this ``Polygon2D``. + ---- .. _class_Polygon2D_method_get_bone_path: - :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const +Returns the path to the node associated with the specified bone. + ---- .. _class_Polygon2D_method_get_bone_weights: -- :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const +- :ref:`PackedFloat32Array` **get_bone_weights** **(** :ref:`int` index **)** const + +Returns the height values of the specified bone. ---- @@ -382,9 +452,13 @@ Method Descriptions - void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** +Sets the path to the node associated with the specified bone. + ---- .. _class_Polygon2D_method_set_bone_weights: -- void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** +- void **set_bone_weights** **(** :ref:`int` index, :ref:`PackedFloat32Array` weights **)** + +Sets the weight values for the specified bone. diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 478bf0c37..1995d5ca4 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -16,30 +16,30 @@ PolygonPathFinder Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`setup` **(** :ref:`PackedVector2Array` points, :ref:`PackedInt32Array` connections **)** | ++-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_PolygonPathFinder_method_find_path: -- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- :ref:`PackedVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** ---- @@ -57,7 +57,7 @@ Method Descriptions .. _class_PolygonPathFinder_method_get_intersections: -- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +- :ref:`PackedVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const ---- @@ -81,5 +81,5 @@ Method Descriptions .. _class_PolygonPathFinder_method_setup: -- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** +- void **setup** **(** :ref:`PackedVector2Array` points, :ref:`PackedInt32Array` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst deleted file mode 100644 index ee5dbccd2..000000000 --- a/classes/class_poolbytearray.rst +++ /dev/null @@ -1,201 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolByteArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_PoolByteArray: - -PoolByteArray -============= - -A pooled :ref:`Array` of bytes. - -Description ------------ - -An :ref:`Array` specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. - -**Note:** This type is passed by value and not by reference. - -Methods -------- - -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`hex_encode` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_PoolByteArray_method_PoolByteArray: - -- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** - -Constructs a new ``PoolByteArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. - ----- - -.. _class_PoolByteArray_method_append: - -- void **append** **(** :ref:`int` byte **)** - -Appends an element at the end of the array (alias of :ref:`push_back`). - ----- - -.. _class_PoolByteArray_method_append_array: - -- void **append_array** **(** :ref:`PoolByteArray` array **)** - -Appends a ``PoolByteArray`` at the end of this array. - ----- - -.. _class_PoolByteArray_method_compress: - -- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** - -Returns a new ``PoolByteArray`` with the data compressed. Set the compression mode using one of :ref:`CompressionMode`'s constants. - ----- - -.. _class_PoolByteArray_method_decompress: - -- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** - -Returns a new ``PoolByteArray`` with the data decompressed. Set ``buffer_size`` to the size of the uncompressed data. Set the compression mode using one of :ref:`CompressionMode`'s constants. - ----- - -.. _class_PoolByteArray_method_empty: - -- :ref:`bool` **empty** **(** **)** - -Returns ``true`` if the array is empty. - ----- - -.. _class_PoolByteArray_method_get_string_from_ascii: - -- :ref:`String` **get_string_from_ascii** **(** **)** - -Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`get_string_from_utf8`. - ----- - -.. _class_PoolByteArray_method_get_string_from_utf8: - -- :ref:`String` **get_string_from_utf8** **(** **)** - -Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. - ----- - -.. _class_PoolByteArray_method_hex_encode: - -- :ref:`String` **hex_encode** **(** **)** - -Returns a hexadecimal representation of this array as a :ref:`String`. - -:: - - var array = PoolByteArray([11, 46, 255]) - print(array.hex_encode()) # Prints: 0b2eff - ----- - -.. _class_PoolByteArray_method_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** - -Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). - ----- - -.. _class_PoolByteArray_method_invert: - -- void **invert** **(** **)** - -Reverses the order of the elements in the array. - ----- - -.. _class_PoolByteArray_method_push_back: - -- void **push_back** **(** :ref:`int` byte **)** - -Appends an element at the end of the array. - ----- - -.. _class_PoolByteArray_method_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Removes an element from the array by index. - ----- - -.. _class_PoolByteArray_method_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - ----- - -.. _class_PoolByteArray_method_set: - -- void **set** **(** :ref:`int` idx, :ref:`int` byte **)** - -Changes the byte at the given index. - ----- - -.. _class_PoolByteArray_method_size: - -- :ref:`int` **size** **(** **)** - -Returns the size of the array. - ----- - -.. _class_PoolByteArray_method_subarray: - -- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** - -Returns the slice of the ``PoolByteArray`` between indices (inclusive) as a new ``PoolByteArray``. Any negative index is considered to be from the end of the array. - diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst deleted file mode 100644 index 38fe0c73c..000000000 --- a/classes/class_poolcolorarray.rst +++ /dev/null @@ -1,136 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolColorArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_PoolColorArray: - -PoolColorArray -============== - -A pooled :ref:`Array` of :ref:`Color`. - -Description ------------ - -An :ref:`Array` specifically designed to hold :ref:`Color`. Optimized for memory usage, does not fragment the memory. - -**Note:** This type is passed by value and not by reference. - -Methods -------- - -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Color` color **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Color` color **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_PoolColorArray_method_PoolColorArray: - -- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** - -Constructs a new ``PoolColorArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. - ----- - -.. _class_PoolColorArray_method_append: - -- void **append** **(** :ref:`Color` color **)** - -Appends an element at the end of the array (alias of :ref:`push_back`). - ----- - -.. _class_PoolColorArray_method_append_array: - -- void **append_array** **(** :ref:`PoolColorArray` array **)** - -Appends a ``PoolColorArray`` at the end of this array. - ----- - -.. _class_PoolColorArray_method_empty: - -- :ref:`bool` **empty** **(** **)** - -Returns ``true`` if the array is empty. - ----- - -.. _class_PoolColorArray_method_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** - -Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). - ----- - -.. _class_PoolColorArray_method_invert: - -- void **invert** **(** **)** - -Reverses the order of the elements in the array. - ----- - -.. _class_PoolColorArray_method_push_back: - -- void **push_back** **(** :ref:`Color` color **)** - -Appends a value to the array. - ----- - -.. _class_PoolColorArray_method_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Removes an element from the array by index. - ----- - -.. _class_PoolColorArray_method_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - ----- - -.. _class_PoolColorArray_method_set: - -- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** - -Changes the :ref:`Color` at the given index. - ----- - -.. _class_PoolColorArray_method_size: - -- :ref:`int` **size** **(** **)** - -Returns the size of the array. - diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst deleted file mode 100644 index 92fca18fc..000000000 --- a/classes/class_poolintarray.rst +++ /dev/null @@ -1,138 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolIntArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_PoolIntArray: - -PoolIntArray -============ - -A pooled :ref:`Array` of integers (:ref:`int`). - -Description ------------ - -An :ref:`Array` specifically designed to hold integer values (:ref:`int`). Optimized for memory usage, does not fragment the memory. - -**Note:** This type is passed by value and not by reference. - -**Note:** This type is limited to signed 32-bit integers, which means it can only take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. - -Methods -------- - -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` integer **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` integer **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` integer **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_PoolIntArray_method_PoolIntArray: - -- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** - -Constructs a new ``PoolIntArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. - ----- - -.. _class_PoolIntArray_method_append: - -- void **append** **(** :ref:`int` integer **)** - -Appends an element at the end of the array (alias of :ref:`push_back`). - ----- - -.. _class_PoolIntArray_method_append_array: - -- void **append_array** **(** :ref:`PoolIntArray` array **)** - -Appends a ``PoolIntArray`` at the end of this array. - ----- - -.. _class_PoolIntArray_method_empty: - -- :ref:`bool` **empty** **(** **)** - -Returns ``true`` if the array is empty. - ----- - -.. _class_PoolIntArray_method_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** - -Inserts a new int at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). - ----- - -.. _class_PoolIntArray_method_invert: - -- void **invert** **(** **)** - -Reverses the order of the elements in the array. - ----- - -.. _class_PoolIntArray_method_push_back: - -- void **push_back** **(** :ref:`int` integer **)** - -Appends a value to the array. - ----- - -.. _class_PoolIntArray_method_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Removes an element from the array by index. - ----- - -.. _class_PoolIntArray_method_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - ----- - -.. _class_PoolIntArray_method_set: - -- void **set** **(** :ref:`int` idx, :ref:`int` integer **)** - -Changes the int at the given index. - ----- - -.. _class_PoolIntArray_method_size: - -- :ref:`int` **size** **(** **)** - -Returns the array size. - diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst deleted file mode 100644 index 43622ede2..000000000 --- a/classes/class_poolrealarray.rst +++ /dev/null @@ -1,136 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolRealArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_PoolRealArray: - -PoolRealArray -============= - -A pooled :ref:`Array` of reals (:ref:`float`). - -Description ------------ - -An :ref:`Array` specifically designed to hold floating-point values (:ref:`float`). Optimized for memory usage, does not fragment the memory. - -**Note:** This type is passed by value and not by reference. - -Methods -------- - -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`float` value **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`float` value **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`float` value **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_PoolRealArray_method_PoolRealArray: - -- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** - -Constructs a new ``PoolRealArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. - ----- - -.. _class_PoolRealArray_method_append: - -- void **append** **(** :ref:`float` value **)** - -Appends an element at the end of the array (alias of :ref:`push_back`). - ----- - -.. _class_PoolRealArray_method_append_array: - -- void **append_array** **(** :ref:`PoolRealArray` array **)** - -Appends a ``PoolRealArray`` at the end of this array. - ----- - -.. _class_PoolRealArray_method_empty: - -- :ref:`bool` **empty** **(** **)** - -Returns ``true`` if the array is empty. - ----- - -.. _class_PoolRealArray_method_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` value **)** - -Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). - ----- - -.. _class_PoolRealArray_method_invert: - -- void **invert** **(** **)** - -Reverses the order of the elements in the array. - ----- - -.. _class_PoolRealArray_method_push_back: - -- void **push_back** **(** :ref:`float` value **)** - -Appends an element at the end of the array. - ----- - -.. _class_PoolRealArray_method_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Removes an element from the array by index. - ----- - -.. _class_PoolRealArray_method_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - ----- - -.. _class_PoolRealArray_method_set: - -- void **set** **(** :ref:`int` idx, :ref:`float` value **)** - -Changes the float at the given index. - ----- - -.. _class_PoolRealArray_method_size: - -- :ref:`int` **size** **(** **)** - -Returns the size of the array. - diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst deleted file mode 100644 index 25113f0ec..000000000 --- a/classes/class_poolstringarray.rst +++ /dev/null @@ -1,146 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PoolStringArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_PoolStringArray: - -PoolStringArray -=============== - -A pooled :ref:`Array` of :ref:`String`. - -Description ------------ - -An :ref:`Array` specifically designed to hold :ref:`String`\ s. Optimized for memory usage, does not fragment the memory. - -**Note:** This type is passed by value and not by reference. - -Methods -------- - -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_PoolStringArray_method_PoolStringArray: - -- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** - -Constructs a new ``PoolStringArray``. Optionally, you can pass in a generic :ref:`Array` that will be converted. - ----- - -.. _class_PoolStringArray_method_append: - -- void **append** **(** :ref:`String` string **)** - -Appends an element at the end of the array (alias of :ref:`push_back`). - ----- - -.. _class_PoolStringArray_method_append_array: - -- void **append_array** **(** :ref:`PoolStringArray` array **)** - -Appends a ``PoolStringArray`` at the end of this array. - ----- - -.. _class_PoolStringArray_method_empty: - -- :ref:`bool` **empty** **(** **)** - -Returns ``true`` if the array is empty. - ----- - -.. _class_PoolStringArray_method_insert: - -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** - -Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``). - ----- - -.. _class_PoolStringArray_method_invert: - -- void **invert** **(** **)** - -Reverses the order of the elements in the array. - ----- - -.. _class_PoolStringArray_method_join: - -- :ref:`String` **join** **(** :ref:`String` delimiter **)** - -Returns a :ref:`String` with each element of the array joined with the given ``delimiter``. - ----- - -.. _class_PoolStringArray_method_push_back: - -- void **push_back** **(** :ref:`String` string **)** - -Appends a string element at end of the array. - ----- - -.. _class_PoolStringArray_method_remove: - -- void **remove** **(** :ref:`int` idx **)** - -Removes an element from the array by index. - ----- - -.. _class_PoolStringArray_method_resize: - -- void **resize** **(** :ref:`int` idx **)** - -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - ----- - -.. _class_PoolStringArray_method_set: - -- void **set** **(** :ref:`int` idx, :ref:`String` string **)** - -Changes the :ref:`String` at the given index. - ----- - -.. _class_PoolStringArray_method_size: - -- :ref:`int` **size** **(** **)** - -Returns the size of the array. - diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index ffccded70..dd94366a4 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -38,152 +38,152 @@ Properties Methods ------- -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_radio_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_count` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** const | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` idx **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hide_on_window_lose_focus` **(** :ref:`bool` enable **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | -+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_radio_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_accelerator` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_count` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` idx **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` idx **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_window_lose_focus` **(** :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_accelerator` **(** :ref:`int` idx, :ref:`int` accel **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_as_separator` **(** :ref:`int` idx, :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_checked` **(** :ref:`int` idx, :ref:`bool` checked **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` icon **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_item_multistate` **(** :ref:`int` idx **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Texture` | checked | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Color` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Color` | font_color_hover | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | hover | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | labeled_separator_left | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | labeled_separator_right | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | panel | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | panel_disabled | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Texture` | radio_checked | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Texture` | radio_unchecked | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`StyleBox` | separator | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Texture` | submenu | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`Texture` | unchecked | | -+---------------------------------+-------------------------+------------------------------+ -| :ref:`int` | vseparation | 4 | -+---------------------------------+-------------------------+------------------------------+ ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Texture2D` | checked | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Color` | font_color_accel | Color( 0.7, 0.7, 0.7, 0.8 ) | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.4, 0.4, 0.4, 0.8 ) | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Color` | font_color_hover | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | hover | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | labeled_separator_left | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | labeled_separator_right | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | panel | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | panel_disabled | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Texture2D` | radio_checked | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Texture2D` | radio_unchecked | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`StyleBox` | separator | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Texture2D` | submenu | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`Texture2D` | unchecked | | ++-----------------------------------+-------------------------+------------------------------+ +| :ref:`int` | vseparation | 4 | ++-----------------------------------+-------------------------+------------------------------+ Signals ------- @@ -320,7 +320,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. _class_PopupMenu_method_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Adds a new checkable item with text ``label`` and icon ``texture``. @@ -332,7 +332,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. _class_PopupMenu_method_add_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_check_shortcut** **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** Adds a new checkable item and assigns the specified :ref:`ShortCut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`ShortCut`'s name. @@ -344,7 +344,7 @@ An ``id`` can optionally be provided. If no ``id`` is provided, one will be crea .. _class_PopupMenu_method_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Adds a new item with text ``label`` and icon ``texture``. @@ -354,7 +354,7 @@ An ``id`` can optionally be provided, as well as an accelerator (``accel``). If .. _class_PopupMenu_method_add_icon_radio_check_item: -- void **add_icon_radio_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_radio_check_item** **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Same as :ref:`add_icon_check_item`, but uses a radio check button. @@ -362,7 +362,7 @@ Same as :ref:`add_icon_check_item`, .. _class_PopupMenu_method_add_icon_radio_check_shortcut: -- void **add_icon_radio_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_radio_check_shortcut** **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** Same as :ref:`add_icon_check_shortcut`, but uses a radio check button. @@ -370,7 +370,7 @@ Same as :ref:`add_icon_check_shortcut` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_shortcut** **(** :ref:`Texture2D` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** Adds a new item and assigns the specified :ref:`ShortCut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`ShortCut`'s name. @@ -478,7 +478,7 @@ Returns the number of items in the ``PopupMenu``. .. _class_PopupMenu_method_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture2D` **get_item_icon** **(** :ref:`int` idx **)** const Returns the icon of the item at index ``idx``. @@ -672,9 +672,9 @@ Enables/disables the item at index ``idx``. When it is disabled, it can't be sel .. _class_PopupMenu_method_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture2D` icon **)** -Replaces the :ref:`Texture` icon of the specified ``idx``. +Replaces the :ref:`Texture2D` icon of the specified ``idx``. ---- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 9a23e208e..c2952eb4d 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -71,7 +71,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:`BaseMaterial3D.CULL_BACK` in :ref:`BaseMaterial3D.cull_mode`. ---- diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index dd3061c12..204a84424 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -343,5 +343,5 @@ The direction of the sun using polar coordinates. | *Getter* | get_texture_size() | +-----------+-------------------------+ -Size of :ref:`Texture` that the ProceduralSky will generate. The size is set using :ref:`TextureSize`. +Size of :ref:`Texture2D` that the ProceduralSky will generate. The size is set using :ref:`TextureSize`. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index ebf448f96..f99108d50 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -25,615 +25,625 @@ When naming a Project Settings property, use the full path to the setting includ Properties ---------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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:`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:`String` | :ref:`application/config/windows_native_icon` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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/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` | ``"PulseAudio"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/output_latency` | ``15`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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/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 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:`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:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.5 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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/hide_home_indicator` | ``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:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`editor/search_in_file_extensions` | ``PoolStringArray( "gd", "shader" )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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/pointing/emulate_mouse_from_touch` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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_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_3` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/log.txt"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``10`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``1024`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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:`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/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:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :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_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/quality/2d/gles2_use_nvidia_rect_flicker_workaround` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | ``false`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth/hdr` | ``true`` | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/quality/depth/hdr.mobile` | ``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:`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:`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:`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/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/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:`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:`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:`String` | :ref:`application/config/windows_native_icon` | ``""`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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/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` | ``"PulseAudio"`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/enable_audio_input` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/mix_rate` | ``44100`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/output_latency` | ``15`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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/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 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:`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:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color( 0, 0.6, 0.7, 0.5 )`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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/hide_home_indicator` | ``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:`bool` | :ref:`display/window/vsync/use_vsync` | ``true`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/vsync/vsync_via_compositor` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/script_templates_search_path` | ``"res://script_templates"`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`editor/search_in_file_extensions` | ``PackedStringArray( "gd", "shader" )`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/swap_ok_cancel` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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/pointing/emulate_mouse_from_touch` | ``true`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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_3` | ``""`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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_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_3` | ``""`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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:`String` | :ref:`logging/file_logging/log_path` | ``"user://logs/log.txt"`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`logging/file_logging/max_log_files` | ``10`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``1024`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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/unhandled_exception_policy` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_chars_per_second` | ``32768`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_errors_per_second` | ``400`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_queued_messages` | ``2048`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_warnings_per_second` | ``400`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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:`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/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:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/physics_fps` | ``60`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`rendering/environment/default_clear_color` | ``Color( 0.3, 0.3, 0.3, 1 )`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/environment/default_environment` | ``""`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/rendering/max_renderable_elements` | ``128000`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/2d/use_pixel_snap` | ``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` | ``"Vulkan"`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/depth_of_field_bokeh_quality` | ``2`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/depth_of_field_bokeh_shape` | ``1`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/depth_of_field_use_jitter` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/max_anisotropy` | ``4`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/msaa` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/filters/screen_space_roughness_limiter` | ``0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/quality/filters/screen_space_roughness_limiter_curve` | ``1.0`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/gi_probes/anisotropic` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/gi_probes/quality` | ``1`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation` | ``2`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/intended_usage/framebuffer_allocation.mobile` | ``3`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflection_atlas/reflection_count` | ``64`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflection_atlas/reflection_size` | ``128`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflection_atlas/reflection_size.mobile` | ``128`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/quality/reflections/fast_filter_high_quality` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/ggx_samples` | ``1024`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/ggx_samples.mobile` | ``128`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/reflections/roughness_layers` | ``6`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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:`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/ssao/half_size` | ``false`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/quality/ssao/quality` | ``1`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/threads/thread_model` | ``1`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :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:`rendering/vulkan/descriptor_pools/max_descriptors_per_pool` | ``64`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/block_size_kb` | ``256`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/max_size_mb` | ``128`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/texture_upload_region_size_px` | ``64`` | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ Methods ------- @@ -673,18 +683,6 @@ Methods Property Descriptions --------------------- -.. _class_ProjectSettings_property_android/modules: - -- :ref:`String` **android/modules** - -+-----------+--------+ -| *Default* | ``""`` | -+-----------+--------+ - -Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. ``org/godotengine/org/GodotPaymentV3,org/godotengine/godot/MyCustomSingleton"``. - ----- - .. _class_ProjectSettings_property_application/boot_splash/bg_color: - :ref:`Color` **application/boot_splash/bg_color** @@ -1093,7 +1091,7 @@ If ``true``, enables warnings when a constant is used as a function. | *Default* | ``true`` | +-----------+----------+ -If ``true``, enables warnings when deprecated keywords such as ``slave`` are used. +If ``true``, enables warnings when deprecated keywords are used. ---- @@ -1825,11 +1823,11 @@ Search path for project-specific script templates. Script templates will be sear .. _class_ProjectSettings_property_editor/search_in_file_extensions: -- :ref:`PoolStringArray` **editor/search_in_file_extensions** +- :ref:`PackedStringArray` **editor/search_in_file_extensions** -+-----------+---------------------------------------+ -| *Default* | ``PoolStringArray( "gd", "shader" )`` | -+-----------+---------------------------------------+ ++-----------+-----------------------------------------+ +| *Default* | ``PackedStringArray( "gd", "shader" )`` | ++-----------+-----------------------------------------+ Text-based file extensions to include in the script editor's "Find in Files" feature. You can add e.g. ``tscn`` if you wish to also parse your scene files, especially if you use built-in scripts which are serialized in the scene files. @@ -3129,51 +3127,111 @@ This is used by servers when used in multi-threading mode (servers and visual). ---- -.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_chars_per_second: +.. _class_ProjectSettings_property_mono/debugger_agent/port: -- :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** +- :ref:`int` **mono/debugger_agent/port** + ++-----------+-----------+ +| *Default* | ``23685`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_mono/debugger_agent/wait_for_debugger: + +- :ref:`bool` **mono/debugger_agent/wait_for_debugger** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_mono/debugger_agent/wait_timeout: + +- :ref:`int` **mono/debugger_agent/wait_timeout** +-----------+----------+ -| *Default* | ``2048`` | +| *Default* | ``3000`` | +-----------+----------+ +---- + +.. _class_ProjectSettings_property_mono/profiler/args: + +- :ref:`String` **mono/profiler/args** + ++-----------+-------------------------------------------------+ +| *Default* | ``"log:calls,alloc,sample,output=output.mlpd"`` | ++-----------+-------------------------------------------------+ + +---- + +.. _class_ProjectSettings_property_mono/profiler/enabled: + +- :ref:`bool` **mono/profiler/enabled** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_mono/unhandled_exception_policy: + +- :ref:`int` **mono/unhandled_exception_policy** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_network/limits/debugger/max_chars_per_second: + +- :ref:`int` **network/limits/debugger/max_chars_per_second** + ++-----------+-----------+ +| *Default* | ``32768`` | ++-----------+-----------+ + 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. ---- -.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_errors_per_second: +.. _class_ProjectSettings_property_network/limits/debugger/max_errors_per_second: -- :ref:`int` **network/limits/debugger_stdout/max_errors_per_second** +- :ref:`int` **network/limits/debugger/max_errors_per_second** +-----------+---------+ -| *Default* | ``100`` | +| *Default* | ``400`` | +-----------+---------+ -Maximum number of errors allowed to be sent as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +Maximum number of errors allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. ---- -.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_messages_per_frame: +.. _class_ProjectSettings_property_network/limits/debugger/max_queued_messages: -- :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** +- :ref:`int` **network/limits/debugger/max_queued_messages** -+-----------+--------+ -| *Default* | ``10`` | -+-----------+--------+ ++-----------+----------+ +| *Default* | ``2048`` | ++-----------+----------+ -Maximum amount of messages 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 messages in the debugger queue. Over this value, content is dropped. This helps to limit the debugger memory usage. ---- -.. _class_ProjectSettings_property_network/limits/debugger_stdout/max_warnings_per_second: +.. _class_ProjectSettings_property_network/limits/debugger/max_warnings_per_second: -- :ref:`int` **network/limits/debugger_stdout/max_warnings_per_second** +- :ref:`int` **network/limits/debugger/max_warnings_per_second** +-----------+---------+ -| *Default* | ``100`` | +| *Default* | ``400`` | +-----------+---------+ -Maximum number of warnings allowed to be sent as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. +Maximum number of warnings allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. ---- @@ -3639,7 +3697,9 @@ Enables :ref:`Viewport.physics_object_picking` methods are run. + +**Note:** This property is only read when the project starts. To change the physics FPS at runtime, set :ref:`Engine.iterations_per_second` instead. ---- @@ -3653,6 +3713,8 @@ Frames per second used in the physics. Physics always needs a fixed amount of fr Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS. +**Note:** This property is only read when the project starts. To change the physics FPS at runtime, set :ref:`Engine.physics_jitter_fix` instead. + ---- .. _class_ProjectSettings_property_rendering/environment/default_clear_color: @@ -3679,102 +3741,18 @@ Default background clear color. Overridable per :ref:`Viewport` ---- -.. _class_ProjectSettings_property_rendering/limits/buffers/blend_shape_max_buffer_size_kb: - -- :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** - -+-----------+----------+ -| *Default* | ``4096`` | -+-----------+----------+ - -Max buffer size for blend shapes. Any blend shape bigger than this will not work. - ----- - -.. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_buffer_size_kb: - -- :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** - -+-----------+---------+ -| *Default* | ``128`` | -+-----------+---------+ - -Max buffer size for drawing polygons. Any polygon bigger than this will not work. - ----- - -.. _class_ProjectSettings_property_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: - -- :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** - -+-----------+---------+ -| *Default* | ``128`` | -+-----------+---------+ - -Max index buffer size for drawing polygons. Any polygon bigger than this will not work. - ----- - -.. _class_ProjectSettings_property_rendering/limits/buffers/immediate_buffer_size_kb: - -- :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** - -+-----------+----------+ -| *Default* | ``2048`` | -+-----------+----------+ - -Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. - ----- - .. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_elements: - :ref:`int` **rendering/limits/rendering/max_renderable_elements** -+-----------+-----------+ -| *Default* | ``65536`` | -+-----------+-----------+ ++-----------+------------+ +| *Default* | ``128000`` | ++-----------+------------+ Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves. ---- -.. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_lights: - -- :ref:`int` **rendering/limits/rendering/max_renderable_lights** - -+-----------+----------+ -| *Default* | ``4096`` | -+-----------+----------+ - -Max number of lights renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. - ----- - -.. _class_ProjectSettings_property_rendering/limits/rendering/max_renderable_reflections: - -- :ref:`int` **rendering/limits/rendering/max_renderable_reflections** - -+-----------+----------+ -| *Default* | ``1024`` | -+-----------+----------+ - -Max number of reflection probes renderable in a frame. If more than this number are used, they will be ignored. On some systems (particularly web) setting this number as low as possible can increase the speed of shader compilation. - ----- - -.. _class_ProjectSettings_property_rendering/limits/time/time_rollover_secs: - -- :ref:`float` **rendering/limits/time/time_rollover_secs** - -+-----------+----------+ -| *Default* | ``3600`` | -+-----------+----------+ - -Shaders have a time variable that constantly increases. At some point, it needs to be rolled back to zero to avoid precision errors on shader animations. This setting specifies when (in seconds). - ----- - .. _class_ProjectSettings_property_rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround: - :ref:`bool` **rendering/quality/2d/gles2_use_nvidia_rect_flicker_workaround** @@ -3785,7 +3763,7 @@ Shaders have a time variable that constantly increases. At some point, it needs Some NVIDIA GPU drivers have a bug which produces flickering issues for the ``draw_rect`` method, especially as used in :ref:`TileMap`. Refer to `GitHub issue 9913 `_ for details. -If ``true``, this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend (so the bug stays if you use GLES3), and only desktop platforms. +If ``true``, this option enables a "safe" code path for such NVIDIA GPUs at the cost of performance. This option only impacts the GLES2 rendering backend, and only desktop platforms. It is not necessary when using the Vulkan backend. ---- @@ -3801,32 +3779,6 @@ If ``true``, forces snapping of polygons to pixels in 2D rendering. May help in ---- -.. _class_ProjectSettings_property_rendering/quality/depth/hdr: - -- :ref:`bool` **rendering/quality/depth/hdr** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - -If ``true``, allocates the main framebuffer with high dynamic range. High dynamic range allows the use of :ref:`Color` values greater than 1. - -**Note:** Only available on the GLES3 backend. - ----- - -.. _class_ProjectSettings_property_rendering/quality/depth/hdr.mobile: - -- :ref:`bool` **rendering/quality/depth/hdr.mobile** - -+-----------+-----------+ -| *Default* | ``false`` | -+-----------+-----------+ - -Lower-end override for :ref:`rendering/quality/depth/hdr` on mobile devices, due to performance concerns or driver support. - ----- - .. _class_ProjectSettings_property_rendering/quality/depth_prepass/disable_for_vendors: - :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** @@ -3879,40 +3831,54 @@ Lower-end override for :ref:`rendering/quality/directional_shadow/size` **rendering/quality/driver/driver_name** -+-----------+-------------+ -| *Default* | ``"GLES3"`` | -+-----------+-------------+ ++-----------+--------------+ +| *Default* | ``"Vulkan"`` | ++-----------+--------------+ -The video driver to use ("GLES2" or "GLES3"). +The video driver to use ("GLES2" or "Vulkan"). -**Note:** The backend in use can be overridden at runtime via the ``--video-driver`` command line argument, or by the :ref:`rendering/quality/driver/fallback_to_gles2` option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use :ref:`OS.get_current_video_driver` to query it at run-time. +**Note:** The backend in use can be overridden at runtime via the ``--video-driver`` command line argument. In such cases, this property is not updated, so use :ref:`OS.get_current_video_driver` to query it at run-time. ---- -.. _class_ProjectSettings_property_rendering/quality/driver/fallback_to_gles2: +.. _class_ProjectSettings_property_rendering/quality/filters/depth_of_field_bokeh_quality: -- :ref:`bool` **rendering/quality/driver/fallback_to_gles2** +- :ref:`int` **rendering/quality/filters/depth_of_field_bokeh_quality** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/quality/filters/depth_of_field_bokeh_shape: + +- :ref:`int` **rendering/quality/filters/depth_of_field_bokeh_shape** + ++-----------+-------+ +| *Default* | ``1`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/quality/filters/depth_of_field_use_jitter: + +- :ref:`bool` **rendering/quality/filters/depth_of_field_use_jitter** +-----------+-----------+ | *Default* | ``false`` | +-----------+-----------+ -If ``true``, allows falling back to the GLES2 driver if the GLES3 driver is not supported. - -**Note:** The two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the data pack's size. - ---- -.. _class_ProjectSettings_property_rendering/quality/filters/anisotropic_filter_level: +.. _class_ProjectSettings_property_rendering/quality/filters/max_anisotropy: -- :ref:`int` **rendering/quality/filters/anisotropic_filter_level** +- :ref:`int` **rendering/quality/filters/max_anisotropy** +-----------+-------+ | *Default* | ``4`` | +-----------+-------+ -Maximum anisotropic filter level used for textures with anisotropy enabled. Higher values will result in sharper textures when viewed from oblique angles, at the cost of performance. Only power-of-two values are valid (2, 4, 8, 16). - ---- .. _class_ProjectSettings_property_rendering/quality/filters/msaa: @@ -3929,6 +3895,26 @@ Sets the number of MSAA samples to use. MSAA is used to reduce aliasing around t ---- +.. _class_ProjectSettings_property_rendering/quality/filters/screen_space_roughness_limiter: + +- :ref:`int` **rendering/quality/filters/screen_space_roughness_limiter** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +---- + +.. _class_ProjectSettings_property_rendering/quality/filters/screen_space_roughness_limiter_curve: + +- :ref:`float` **rendering/quality/filters/screen_space_roughness_limiter_curve** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +---- + .. _class_ProjectSettings_property_rendering/quality/filters/use_nearest_mipmap_filter: - :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** @@ -3941,6 +3927,26 @@ If ``true``, uses nearest-neighbor mipmap filtering when using mipmaps (also cal ---- +.. _class_ProjectSettings_property_rendering/quality/gi_probes/anisotropic: + +- :ref:`bool` **rendering/quality/gi_probes/anisotropic** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +---- + +.. _class_ProjectSettings_property_rendering/quality/gi_probes/quality: + +- :ref:`int` **rendering/quality/gi_probes/quality** + ++-----------+-------+ +| *Default* | ``1`` | ++-----------+-------+ + +---- + .. _class_ProjectSettings_property_rendering/quality/intended_usage/framebuffer_allocation: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** @@ -3965,65 +3971,87 @@ Lower-end override for :ref:`rendering/quality/intended_usage/framebuffer_alloca ---- -.. _class_ProjectSettings_property_rendering/quality/reflections/atlas_size: +.. _class_ProjectSettings_property_rendering/quality/reflection_atlas/reflection_count: -- :ref:`int` **rendering/quality/reflections/atlas_size** +- :ref:`int` **rendering/quality/reflection_atlas/reflection_count** -+-----------+----------+ -| *Default* | ``2048`` | -+-----------+----------+ ++-----------+--------+ +| *Default* | ``64`` | ++-----------+--------+ -Size of the atlas used by reflection probes. A larger size can result in higher visual quality, while a smaller size will be faster and take up less memory. +Number of cubemaps to store in the reflection atlas. The number of :ref:`ReflectionProbe`\ s in a scene will be limited by this amount. A higher number requires more VRAM. ---- -.. _class_ProjectSettings_property_rendering/quality/reflections/atlas_subdiv: +.. _class_ProjectSettings_property_rendering/quality/reflection_atlas/reflection_size: -- :ref:`int` **rendering/quality/reflections/atlas_subdiv** - -+-----------+-------+ -| *Default* | ``8`` | -+-----------+-------+ - -Number of subdivisions to use for the reflection atlas. A higher number lowers the quality of each atlas, but allows you to use more. - ----- - -.. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx: - -- :ref:`bool` **rendering/quality/reflections/high_quality_ggx** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - -If ``true``, uses a high amount of samples to create blurred variants of reflection probes and panorama backgrounds (sky). Those blurred variants are used by rough materials. - ----- - -.. _class_ProjectSettings_property_rendering/quality/reflections/high_quality_ggx.mobile: - -- :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** - -+-----------+-----------+ -| *Default* | ``false`` | -+-----------+-----------+ - -Lower-end override for :ref:`rendering/quality/reflections/high_quality_ggx` on mobile devices, due to performance concerns or driver support. - ----- - -.. _class_ProjectSettings_property_rendering/quality/reflections/irradiance_max_size: - -- :ref:`int` **rendering/quality/reflections/irradiance_max_size** +- :ref:`int` **rendering/quality/reflection_atlas/reflection_size** +-----------+---------+ | *Default* | ``128`` | +-----------+---------+ -Limits the size of the irradiance map which is normally determined by :ref:`Sky.radiance_size`. A higher size results in a higher quality irradiance map similarly to :ref:`rendering/quality/reflections/high_quality_ggx`. Use a higher value when using high-frequency HDRI maps, otherwise keep this as low as possible. +Size of cubemap faces for :ref:`ReflectionProbe`\ s. A higher number requires more VRAM and may make reflection probe updating slower. -**Note:** Low and mid range hardware do not support complex irradiance maps well and may crash if this is set too high. +---- + +.. _class_ProjectSettings_property_rendering/quality/reflection_atlas/reflection_size.mobile: + +- :ref:`int` **rendering/quality/reflection_atlas/reflection_size.mobile** + ++-----------+---------+ +| *Default* | ``128`` | ++-----------+---------+ + +Lower-end override for :ref:`rendering/quality/reflection_atlas/reflection_size` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/quality/reflections/fast_filter_high_quality: + +- :ref:`bool` **rendering/quality/reflections/fast_filter_high_quality** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +Use a higher quality variant of the fast filtering algorithm. Significantly slower than using default quality, but results in smoother reflections. Should only be used when the scene is especially detailed. + +---- + +.. _class_ProjectSettings_property_rendering/quality/reflections/ggx_samples: + +- :ref:`int` **rendering/quality/reflections/ggx_samples** + ++-----------+----------+ +| *Default* | ``1024`` | ++-----------+----------+ + +Sets the number of samples to take when using importance sampling for :ref:`Sky`\ s and :ref:`ReflectionProbe`\ s. A higher value will result in smoother, higher quality reflections, but increases time to calculate radiance maps. In general, fewer samples are needed for simpler, low dynamic range environments while more samples are needed for HDR environments and environments with a high level of detail. + +---- + +.. _class_ProjectSettings_property_rendering/quality/reflections/ggx_samples.mobile: + +- :ref:`int` **rendering/quality/reflections/ggx_samples.mobile** + ++-----------+---------+ +| *Default* | ``128`` | ++-----------+---------+ + +Lower-end override for :ref:`rendering/quality/reflections/ggx_samples` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/quality/reflections/roughness_layers: + +- :ref:`int` **rendering/quality/reflections/roughness_layers** + ++-----------+-------+ +| *Default* | ``6`` | ++-----------+-------+ + +Limits the number of layers to use in radiance maps when using importance sampling. A lower number will be slightly faster and take up less VRAM. ---- @@ -4035,7 +4063,7 @@ Limits the size of the irradiance map which is normally determined by :ref:`Sky. | *Default* | ``true`` | +-----------+----------+ -If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise on reflections, but costs more performance and memory. +If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise and upscaling artifacts on reflections, but is significantly slower to compute and uses :ref:`rendering/quality/reflections/roughness_layers` times more memory. ---- @@ -4219,64 +4247,24 @@ Lower-end override for :ref:`rendering/quality/shadows/filter_mode` **rendering/quality/subsurface_scattering/follow_surface** +- :ref:`bool` **rendering/quality/ssao/half_size** +-----------+-----------+ | *Default* | ``false`` | +-----------+-----------+ -Improves quality of subsurface scattering, but cost significantly increases. - ---- -.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/quality: +.. _class_ProjectSettings_property_rendering/quality/ssao/quality: -- :ref:`int` **rendering/quality/subsurface_scattering/quality** +- :ref:`int` **rendering/quality/ssao/quality** +-----------+-------+ | *Default* | ``1`` | +-----------+-------+ -Quality setting for subsurface scattering (samples taken). - ----- - -.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/scale: - -- :ref:`int` **rendering/quality/subsurface_scattering/scale** - -+-----------+---------+ -| *Default* | ``1.0`` | -+-----------+---------+ - -Max radius used for subsurface scattering samples. - ----- - -.. _class_ProjectSettings_property_rendering/quality/subsurface_scattering/weight_samples: - -- :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - -Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. - ----- - -.. _class_ProjectSettings_property_rendering/quality/voxel_cone_tracing/high_quality: - -- :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** - -+-----------+-----------+ -| *Default* | ``false`` | -+-----------+-----------+ - -Use high-quality voxel cone tracing. This results in better-looking reflections, but is much more expensive on the GPU. - ---- .. _class_ProjectSettings_property_rendering/threads/thread_model: @@ -4299,7 +4287,7 @@ Thread model for rendering. Rendering on a thread can vastly improve performance | *Default* | ``false`` | +-----------+-----------+ -If ``true``, the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the GLES3 renderer. +If ``true``, the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer. ---- @@ -4323,7 +4311,7 @@ If ``true``, the texture importer will import VRAM-compressed textures using the | *Default* | ``true`` | +-----------+----------+ -If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the GLES3 renderer. +If ``true``, the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the Vulkan renderer. ---- @@ -4349,6 +4337,46 @@ If ``true``, the texture importer will import VRAM-compressed textures using the If ``true``, the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. +---- + +.. _class_ProjectSettings_property_rendering/vulkan/descriptor_pools/max_descriptors_per_pool: + +- :ref:`int` **rendering/vulkan/descriptor_pools/max_descriptors_per_pool** + ++-----------+--------+ +| *Default* | ``64`` | ++-----------+--------+ + +---- + +.. _class_ProjectSettings_property_rendering/vulkan/staging_buffer/block_size_kb: + +- :ref:`int` **rendering/vulkan/staging_buffer/block_size_kb** + ++-----------+---------+ +| *Default* | ``256`` | ++-----------+---------+ + +---- + +.. _class_ProjectSettings_property_rendering/vulkan/staging_buffer/max_size_mb: + +- :ref:`int` **rendering/vulkan/staging_buffer/max_size_mb** + ++-----------+---------+ +| *Default* | ``128`` | ++-----------+---------+ + +---- + +.. _class_ProjectSettings_property_rendering/vulkan/staging_buffer/texture_upload_region_size_px: + +- :ref:`int` **rendering/vulkan/staging_buffer/texture_upload_region_size_px** + ++-----------+--------+ +| *Default* | ``64`` | ++-----------+--------+ + Method Descriptions ------------------- diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 07db13fcf..ddc7382a8 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -9,25 +9,23 @@ ProxyTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Properties ---------- -+-------------------------------+-----------------------------------------------+--------------+ -| :ref:`Texture` | :ref:`base` | | -+-------------------------------+-----------------------------------------------+--------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-------------------------------+-----------------------------------------------+--------------+ ++-----------------------------------+-----------------------------------------------+ +| :ref:`Texture2D` | :ref:`base` | ++-----------------------------------+-----------------------------------------------+ Property Descriptions --------------------- .. _class_ProxyTexture_property_base: -- :ref:`Texture` **base** +- :ref:`Texture2D` **base** +----------+-----------------+ | *Setter* | set_base(value) | diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 4745ad906..f2221b16b 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -9,12 +9,14 @@ Rect2 ===== -2D axis-aligned bounding box. +2D axis-aligned bounding box using floating point coordinates. Description ----------- -Rect2 consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. +``Rect2`` consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + +It uses floating point coordinates. Tutorials --------- @@ -40,6 +42,8 @@ Methods +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Rect2i` from **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`abs` **(** **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | @@ -60,7 +64,7 @@ Methods +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Rect2` rect **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,6 +125,12 @@ Constructs a ``Rect2`` by x, y, width, and height. ---- +- :ref:`Rect2` **Rect2** **(** :ref:`Rect2i` from **)** + +Constructs a ``Rect2`` from a :ref:`Rect2i`. + +---- + .. _class_Rect2_method_abs: - :ref:`Rect2` **abs** **(** **)** @@ -203,9 +213,11 @@ Returns ``true`` if the ``Rect2`` contains a point. .. _class_Rect2_method_intersects: -- :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** +- :ref:`bool` **intersects** **(** :ref:`Rect2` b, :ref:`bool` include_borders=false **)** -Returns ``true`` if the ``Rect2`` overlaps with another. +Returns ``true`` if the ``Rect2`` overlaps with ``b`` (i.e. they have at least one point in common). + +If ``include_borders`` is ``true``, they will also be considered overlapping if their borders touch, even without intersection. ---- diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst new file mode 100644 index 000000000..9d744d582 --- /dev/null +++ b/classes/class_rect2i.rst @@ -0,0 +1,57 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Rect2i.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Rect2i: + +Rect2i +====== + +2D axis-aligned bounding box using integer coordinates. + +Description +----------- + +``Rect2i`` consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + +It uses integer coordinates. + +Tutorials +--------- + +- :doc:`../tutorials/math/index` + +Methods +------- + ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`Rect2i` **(** :ref:`Rect2` from **)** | ++-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Rect2i_method_Rect2i: + +- :ref:`Rect2i` **Rect2i** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** + +Constructs a ``Rect2i`` by position and size. + +---- + +- :ref:`Rect2i` **Rect2i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` width, :ref:`int` height **)** + +Constructs a ``Rect2i`` by x, y, width, and height. + +---- + +- :ref:`Rect2i` **Rect2i** **(** :ref:`Rect2` from **)** + +Constructs a new ``Rect2i`` from :ref:`Rect2`. The floating point coordinates will be truncated. + diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 3cb0b5dd0..2dec2529d 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -11,7 +11,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSONParseResult`, :ref:`JavaClass`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AStar2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSONParseResult`, :ref:`JavaClass`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`MeshDataTool`, :ref:`MonoGCHandle`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser` Base class for reference-counted objects. diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index f47dd8c06..1a6530e35 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -16,7 +16,7 @@ Captures its surroundings to create reflections. Description ----------- -Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses. +Captures its surroundings as a cubemap, and stores versions of it with increasing levels of blur to simulate different material roughnesses. The ``ReflectionProbe`` is used to create high-quality reflections at the cost of performance. It can be combined with :ref:`GIProbe`\ s and Screen Space Reflections to achieve high quality reflections. ``ReflectionProbe``\ s render all objects within their :ref:`cull_mask`, so updating them can be quite expensive. It is best to update them once with the important static objects and then leave them. @@ -65,7 +65,7 @@ Enumerations enum **UpdateMode**: -- **UPDATE_ONCE** = **0** --- Update the probe once on the next frame. +- **UPDATE_ONCE** = **0** --- Update the probe once on the next frame. The corresponding radiance map will be generated over the following six frames. This is slower to update than :ref:`UPDATE_ALWAYS` but can result in higher quality reflections. - **UPDATE_ALWAYS** = **1** --- Update the probe every frame. This is needed when you want to capture dynamic objects. However, it results in an increased render time. Use :ref:`UPDATE_ONCE` whenever possible. diff --git a/classes/class_regex.rst b/classes/class_regex.rst index e9ce7cb77..1aa64faf3 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -25,7 +25,7 @@ To begin, the RegEx object needs to be compiled with the search pattern using :r var regex = RegEx.new() regex.compile("\\w-(\\d+)") -The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"``. +The search pattern must be escaped first for GDScript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"``. Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using functions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. @@ -58,6 +58,10 @@ If you need to process multiple results, :ref:`search_all`_ library. You can view the full pattern reference `here `_. + +**Tip:** You can use `Regexr `_ to test regular expressions online. + Methods ------- diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst new file mode 100644 index 000000000..8de08a24c --- /dev/null +++ b/classes/class_renderingdevice.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the RenderingDevice.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_RenderingDevice: + +RenderingDevice +=============== + +**Inherits:** :ref:`Object` + + + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 1cb32cc1a..2c0e6dd19 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -11,7 +11,7 @@ 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:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :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:`BitMap`, :ref:`ButtonGroup`, :ref:`CameraEffects`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`DynamicFontData`, :ref:`EditorSettings`, :ref:`EditorSpatialGizmoPlugin`, :ref:`Environment`, :ref:`Font`, :ref:`GDNativeLibrary`, :ref:`GIProbeData`, :ref:`Gradient`, :ref:`Image`, :ref:`InputEvent`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`OccluderPolygon2D`, :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:`Theme`, :ref:`TileSet`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualScriptNode`, :ref:`VisualShaderNode`, :ref:`World`, :ref:`World2D`, :ref:`X509Certificate` Base class for all resources. @@ -142,7 +142,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 RID of the resource (or an empty RID). Many resources (such as :ref:`Texture2D`, :ref:`Mesh`, etc) are high-level abstractions of resources stored in a server, so this function will return the original RID. ---- diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index 00fa42ff7..8d36b7de0 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -27,19 +27,19 @@ Extending this class allows you to define your own loader. Be sure to respect th Methods ------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_dependencies` **(** :ref:`String` path, :ref:`String` add_types **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** :ref:`String` path **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles_type` **(** :ref:`String` typename **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`load` **(** :ref:`String` path, :ref:`String` original_path **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rename_dependencies` **(** :ref:`String` path, :ref:`String` renames **)** virtual | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_dependencies` **(** :ref:`String` path, :ref:`String` add_types **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_recognized_extensions` **(** **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** :ref:`String` path **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles_type` **(** :ref:`StringName` typename **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`load` **(** :ref:`String` path, :ref:`String` original_path **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rename_dependencies` **(** :ref:`String` path, :ref:`String` renames **)** virtual | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -56,7 +56,7 @@ If implemented, gets the dependencies of a given resource. If ``add_types`` is ` .. _class_ResourceFormatLoader_method_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** virtual +- :ref:`PackedStringArray` **get_recognized_extensions** **(** **)** virtual Gets the list of extensions for files this loader is able to read. @@ -74,7 +74,7 @@ Gets the class name of the resource associated with the given path. If the loade .. _class_ResourceFormatLoader_method_handles_type: -- :ref:`bool` **handles_type** **(** :ref:`String` typename **)** virtual +- :ref:`bool` **handles_type** **(** :ref:`StringName` typename **)** virtual Tells which resource class this loader can load. diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index 6eb8e6b63..3f289acaf 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -25,20 +25,20 @@ By default, Godot saves resources as ``.tres`` (text-based), ``.res`` (binary) o Methods ------- -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` resource **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`recognize` **(** :ref:`Resource` resource **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` resource **)** virtual | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`recognize` **(** :ref:`Resource` resource **)** virtual | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ResourceFormatSaver_method_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual +- :ref:`PackedStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`recognize`). diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst deleted file mode 100644 index 11ad6a203..000000000 --- a/classes/class_resourceinteractiveloader.rst +++ /dev/null @@ -1,86 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the ResourceInteractiveLoader.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_ResourceInteractiveLoader: - -ResourceInteractiveLoader -========================= - -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -Interactive :ref:`Resource` loader. - -Description ------------ - -Interactive :ref:`Resource` loader. This object is returned by :ref:`ResourceLoader` when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages. - -Methods -------- - -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_stage_count` **(** **)** const | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+---------------------------------------+--------------------------------------------------------------------------------------------------+ - -Method Descriptions -------------------- - -.. _class_ResourceInteractiveLoader_method_get_resource: - -- :ref:`Resource` **get_resource** **(** **)** - -Returns the loaded resource if the load operation completed successfully, ``null`` otherwise. - ----- - -.. _class_ResourceInteractiveLoader_method_get_stage: - -- :ref:`int` **get_stage** **(** **)** const - -Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count`. - ----- - -.. _class_ResourceInteractiveLoader_method_get_stage_count: - -- :ref:`int` **get_stage_count** **(** **)** const - -Returns the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. - ----- - -.. _class_ResourceInteractiveLoader_method_poll: - -- :ref:`Error` **poll** **(** **)** - -Polls the loading operation, i.e. loads a data chunk up to the next stage. - -Returns :ref:`@GlobalScope.OK` if the poll is successful but the load operation has not finished yet (intermediate stage). This means :ref:`poll` will have to be called again until the last stage is completed. - -Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. - -Returns another :ref:`Error` code if the poll has failed. - ----- - -.. _class_ResourceInteractiveLoader_method_wait: - -- :ref:`Error` **wait** **(** **)** - -Polls the loading operation successively until the resource is completely loaded or a :ref:`poll` fails. - -Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. - -Returns another :ref:`Error` code if a poll has failed, aborting the operation. - diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 5a872e8df..76e496a36 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -25,23 +25,48 @@ GDScript has a simplified :ref:`@GDScript.load` bui Methods ------- -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load_threaded_get` **(** :ref:`String` path **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ThreadLoadStatus` | :ref:`load_threaded_get_status` **(** :ref:`String` path, :ref:`Array` progress=[ ] **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_threaded_request` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` use_sub_threads=false **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_ResourceLoader_ThreadLoadStatus: + +.. _class_ResourceLoader_constant_THREAD_LOAD_INVALID_RESOURCE: + +.. _class_ResourceLoader_constant_THREAD_LOAD_IN_PROGRESS: + +.. _class_ResourceLoader_constant_THREAD_LOAD_FAILED: + +.. _class_ResourceLoader_constant_THREAD_LOAD_LOADED: + +enum **ThreadLoadStatus**: + +- **THREAD_LOAD_INVALID_RESOURCE** = **0** --- The resource is invalid, or has not been loaded with :ref:`load_threaded_request`. + +- **THREAD_LOAD_IN_PROGRESS** = **1** --- The resource is still being loaded. + +- **THREAD_LOAD_FAILED** = **2** --- Some error occurred during loading and it failed. + +- **THREAD_LOAD_LOADED** = **3** --- The resource was loaded successfully and can be accessed via :ref:`load_threaded_get`. Method Descriptions ------------------- @@ -58,7 +83,7 @@ An optional ``type_hint`` can be used to further specify the :ref:`Resource` **get_dependencies** **(** :ref:`String` path **)** +- :ref:`PackedStringArray` **get_dependencies** **(** :ref:`String` path **)** Returns the dependencies for the resource at the given ``path``. @@ -66,27 +91,19 @@ Returns the dependencies for the resource at the given ``path``. .. _class_ResourceLoader_method_get_recognized_extensions_for_type: -- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** +- :ref:`PackedStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Returns the list of recognized extensions for a resource type. ---- -.. _class_ResourceLoader_method_has: - -- :ref:`bool` **has** **(** :ref:`String` path **)** - -*Deprecated method.* Use :ref:`has_cached` or :ref:`exists` instead. - ----- - .. _class_ResourceLoader_method_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** Returns whether a cached resource is available for the given ``path``. -Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the :ref:`load` or :ref:`load_interactive` methods will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path` on a new resource for that same path. +Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the :ref:`load` method will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path` on a new resource for that same path. ---- @@ -106,13 +123,31 @@ Returns an empty resource if no ResourceFormatLoader could handle the file. ---- -.. _class_ResourceLoader_method_load_interactive: +.. _class_ResourceLoader_method_load_threaded_get: -- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +- :ref:`Resource` **load_threaded_get** **(** :ref:`String` path **)** -Starts loading a resource interactively. The returned :ref:`ResourceInteractiveLoader` object allows to load with high granularity, calling its :ref:`ResourceInteractiveLoader.poll` method successively to load chunks. +Returns the resource loaded by :ref:`load_threaded_request`. -An optional ``type_hint`` can be used to further specify the :ref:`Resource` type that should be handled by the :ref:`ResourceFormatLoader`. +If this is called before the loading thread is done (i.e. :ref:`load_threaded_get_status` is not :ref:`THREAD_LOAD_LOADED`), the calling thread will be blocked until the resource has finished loading. + +---- + +.. _class_ResourceLoader_method_load_threaded_get_status: + +- :ref:`ThreadLoadStatus` **load_threaded_get_status** **(** :ref:`String` path, :ref:`Array` progress=[ ] **)** + +Returns the status of a threaded loading operation started with :ref:`load_threaded_request` for the resource at ``path``. See :ref:`ThreadLoadStatus` for possible return values. + +An array variable can optionally be passed via ``progress``, and will return a one-element array containing the percentage of completion of the threaded loading. + +---- + +.. _class_ResourceLoader_method_load_threaded_request: + +- :ref:`Error` **load_threaded_request** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` use_sub_threads=false **)** + +Loads the resource using threads. If ``use_sub_threads`` is ``true``, multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). ---- diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index d87e8889e..6cd9d0085 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -23,26 +23,26 @@ GDScript has a simplified :ref:`@GDScript.preload` **(** :ref:`String` name, :ref:`Resource` resource **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_resource` **(** :ref:`String` name **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_resource` **(** :ref:`StringName` name, :ref:`Resource` resource **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_resource_list` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_resource` **(** :ref:`StringName` name **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_resource` **(** :ref:`StringName` name **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_resource` **(** :ref:`StringName` name, :ref:`StringName` newname **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_ResourcePreloader_method_add_resource: -- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** +- void **add_resource** **(** :ref:`StringName` name, :ref:`Resource` resource **)** Adds a resource to the preloader with the given ``name``. If a resource with the given ``name`` already exists, the new resource will be renamed to "``name`` N" where N is an incrementing number starting from 2. @@ -50,7 +50,7 @@ Adds a resource to the preloader with the given ``name``. If a resource with the .. _class_ResourcePreloader_method_get_resource: -- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const +- :ref:`Resource` **get_resource** **(** :ref:`StringName` name **)** const Returns the resource associated to ``name``. @@ -58,7 +58,7 @@ Returns the resource associated to ``name``. .. _class_ResourcePreloader_method_get_resource_list: -- :ref:`PoolStringArray` **get_resource_list** **(** **)** const +- :ref:`PackedStringArray` **get_resource_list** **(** **)** const Returns the list of resources inside the preloader. @@ -66,7 +66,7 @@ Returns the list of resources inside the preloader. .. _class_ResourcePreloader_method_has_resource: -- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const +- :ref:`bool` **has_resource** **(** :ref:`StringName` name **)** const Returns ``true`` if the preloader contains a resource associated to ``name``. @@ -74,7 +74,7 @@ Returns ``true`` if the preloader contains a resource associated to ``name``. .. _class_ResourcePreloader_method_remove_resource: -- void **remove_resource** **(** :ref:`String` name **)** +- void **remove_resource** **(** :ref:`StringName` name **)** Removes the resource associated to ``name`` from the preloader. @@ -82,7 +82,7 @@ Removes the resource associated to ``name`` from the preloader. .. _class_ResourcePreloader_method_rename_resource: -- void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_resource** **(** :ref:`StringName` name, :ref:`StringName` newname **)** Renames a resource inside the preloader from ``name`` to ``newname``. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 49351849d..b33791852 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -23,11 +23,11 @@ It uses the many :ref:`ResourceFormatSaver` classes r Methods ------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** | -+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** | ++---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -69,7 +69,7 @@ Method Descriptions .. _class_ResourceSaver_method_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** +- :ref:`PackedStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Returns the list of extensions available for saving a resource of a given type. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index aa3c2bf20..cd098d0e7 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -60,7 +60,7 @@ Methods ------- +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0 **)** | +| void | :ref:`add_image` **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0 **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_text` **(** :ref:`String` text **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -84,7 +84,7 @@ Methods +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PoolStringArray` expressions **)** | +| :ref:`Dictionary` | :ref:`parse_expressions_for_values` **(** :ref:`PackedStringArray` expressions **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pop` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -518,7 +518,7 @@ Method Descriptions .. _class_RichTextLabel_method_add_image: -- void **add_image** **(** :ref:`Texture` image, :ref:`int` width=0, :ref:`int` height=0 **)** +- void **add_image** **(** :ref:`Texture2D` image, :ref:`int` width=0, :ref:`int` height=0 **)** Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image. @@ -616,7 +616,7 @@ The assignment version of :ref:`append_bbcode` **parse_expressions_for_values** **(** :ref:`PoolStringArray` expressions **)** +- :ref:`Dictionary` **parse_expressions_for_values** **(** :ref:`PackedStringArray` expressions **)** Parses BBCode parameter ``expressions`` into a dictionary. diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index c77dc4bba..874bd0dcd 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -51,8 +51,6 @@ Properties +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`axis_lock_linear_z` | ``false`` | +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`bounce` | | -+-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`can_sleep` | ``true`` | +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`contact_monitor` | ``false`` | @@ -63,8 +61,6 @@ Properties +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`custom_integrator` | ``false`` | +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`friction` | | -+-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`float` | :ref:`gravity_scale` | ``1.0`` | +-----------------------------------------------+--------------------------------------------------------------------------------------+------------------------+ | :ref:`float` | :ref:`linear_damp` | ``-1.0`` | @@ -308,22 +304,6 @@ Lock the body's movement in the Z axis. ---- -.. _class_RigidBody_property_bounce: - -- :ref:`float` **bounce** - -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ - -The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). - -Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. - ----- - .. _class_RigidBody_property_can_sleep: - :ref:`bool` **can_sleep** @@ -406,22 +386,6 @@ If ``true``, internal force integration will be disabled (like gravity or air fr ---- -.. _class_RigidBody_property_friction: - -- :ref:`float` **friction** - -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ - -The body's friction, from 0 (frictionless) to 1 (max friction). - -Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. - ----- - .. _class_RigidBody_property_gravity_scale: - :ref:`float` **gravity_scale** diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 6b72904ca..369ef07e0 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -38,8 +38,6 @@ Properties +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`applied_torque` | ``0.0`` | +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`bounce` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`can_sleep` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`contact_monitor` | ``false`` | @@ -50,8 +48,6 @@ Properties +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`custom_integrator` | ``false`` | +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`friction` | | -+-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`gravity_scale` | ``1.0`` | +-----------------------------------------------+----------------------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`inertia` | | @@ -245,22 +241,6 @@ The body's total applied torque. ---- -.. _class_RigidBody2D_property_bounce: - -- :ref:`float` **bounce** - -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ - -The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). - -Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. - ----- - .. _class_RigidBody2D_property_can_sleep: - :ref:`bool` **can_sleep** @@ -343,22 +323,6 @@ If ``true``, internal force integration is disabled for this body. Aside from co ---- -.. _class_RigidBody2D_property_friction: - -- :ref:`float` **friction** - -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ - -The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). - -Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. - ----- - .. _class_RigidBody2D_property_gravity_scale: - :ref:`float` **gravity_scale** diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 8b06e774a..dcd7085f8 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -23,47 +23,47 @@ This class cannot be instantiated directly, it is retrieved for a given scene as Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_count` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_count` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -119,7 +119,7 @@ Returns the connection flags for the signal at ``idx``. See :ref:`ConnectFlags` **get_connection_method** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_connection_method** **(** :ref:`int` idx **)** const Returns the method connected to the signal at ``idx``. @@ -127,7 +127,7 @@ Returns the method connected to the signal at ``idx``. .. _class_SceneState_method_get_connection_signal: -- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_connection_signal** **(** :ref:`int` idx **)** const Returns the name of the signal at ``idx``. @@ -161,7 +161,7 @@ The ``idx`` argument used to query node data in other ``get_node_*`` methods in .. _class_SceneState_method_get_node_groups: -- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const +- :ref:`PackedStringArray` **get_node_groups** **(** :ref:`int` idx **)** const Returns the list of group names associated with the node at ``idx``. @@ -193,7 +193,7 @@ Returns the path to the represented scene file if the node at ``idx`` is an :ref .. _class_SceneState_method_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_node_name** **(** :ref:`int` idx **)** const Returns the name of the node at ``idx``. @@ -229,7 +229,7 @@ The ``prop_idx`` argument used to query node property data in other ``get_node_p .. _class_SceneState_method_get_node_property_name: -- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`StringName` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const Returns the name of the property at ``prop_idx`` for the node at ``idx``. @@ -245,7 +245,7 @@ Returns the value of the property at ``prop_idx`` for the node at ``idx``. .. _class_SceneState_method_get_node_type: -- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const +- :ref:`StringName` **get_node_type** **(** :ref:`int` idx **)** const Returns the type of the node at ``idx``. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 5462f3e1d..3fa3ce8c7 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -59,59 +59,59 @@ Properties Methods ------- -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method, ... **)** vararg | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** vararg | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_input_handled` **(** **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_server` **(** **)** const | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** :ref:`int` exit_code=-1 **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_as_handled` **(** **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_quit_on_go_back` **(** :ref:`bool` enabled **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | -+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_group` **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** vararg | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** vararg | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_network_connected_peers` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`StringName` group **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_group` **(** :ref:`StringName` name **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_network_peer` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_input_handled` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_server` **(** **)** const | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`StringName` group, :ref:`int` notification **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** :ref:`int` exit_code=-1 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_as_handled` **(** **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_quit_on_go_back` **(** :ref:`bool` enabled **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | ++-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -134,7 +134,7 @@ Emitted whenever this ``SceneTree``'s :ref:`network_peer` files, :ref:`int` screen **)** +- **files_dropped** **(** :ref:`PackedStringArray` files, :ref:`int` screen **)** Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. @@ -477,7 +477,7 @@ Method Descriptions .. _class_SceneTree_method_call_group: -- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_group** **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** vararg Calls ``method`` on each member of the given group. @@ -485,7 +485,7 @@ Calls ``method`` on each member of the given group. .. _class_SceneTree_method_call_group_flags: -- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** vararg Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. @@ -538,7 +538,7 @@ Returns the current frame number, i.e. the total frame count since the applicati .. _class_SceneTree_method_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PackedInt32Array` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this ``SceneTree``'s :ref:`network_peer`. @@ -562,7 +562,7 @@ Returns the number of nodes in this ``SceneTree``. .. _class_SceneTree_method_get_nodes_in_group: -- :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** +- :ref:`Array` **get_nodes_in_group** **(** :ref:`StringName` group **)** Returns a list of all nodes assigned to the given group. @@ -578,7 +578,7 @@ Returns the sender's peer ID for the most recently received RPC call. .. _class_SceneTree_method_has_group: -- :ref:`bool` **has_group** **(** :ref:`String` name **)** const +- :ref:`bool` **has_group** **(** :ref:`StringName` name **)** const Returns ``true`` if the given group exists. @@ -610,7 +610,7 @@ Returns ``true`` if this ``SceneTree``'s :ref:`network_peer` group, :ref:`int` notification **)** +- void **notify_group** **(** :ref:`StringName` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``. @@ -618,7 +618,7 @@ Sends the given notification to all members of the ``group``. .. _class_SceneTree_method_notify_group_flags: -- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** +- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. @@ -662,7 +662,7 @@ For mobile platforms, see :ref:`set_quit_on_go_back` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group** **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group. @@ -670,7 +670,7 @@ Sets the given ``property`` to ``value`` on all members of the given group. .. _class_SceneTree_method_set_group_flags: -- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. diff --git a/classes/class_script.rst b/classes/class_script.rst index 504331f04..6eb6eb34a 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -37,33 +37,33 @@ Properties Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_base_script` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_property_default_value` **(** :ref:`String` property **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_script_constant_map` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_script_method_list` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_script_property_list` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_script_signal_list` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_source_code` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_tool` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_base_script` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_instance_base_type` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_property_default_value` **(** :ref:`StringName` property **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_script_constant_map` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_method_list` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_property_list` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_script_signal_list` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`StringName` signal_name **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_source_code` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tool` **(** **)** const | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -101,7 +101,7 @@ Returns the script directly inherited by this script. .. _class_Script_method_get_instance_base_type: -- :ref:`String` **get_instance_base_type** **(** **)** const +- :ref:`StringName` **get_instance_base_type** **(** **)** const Returns the script's base type. @@ -109,7 +109,9 @@ Returns the script's base type. .. _class_Script_method_get_property_default_value: -- :ref:`Variant` **get_property_default_value** **(** :ref:`String` property **)** +- :ref:`Variant` **get_property_default_value** **(** :ref:`StringName` property **)** + +Returns the default value of the specified property. ---- @@ -117,29 +119,37 @@ Returns the script's base type. - :ref:`Dictionary` **get_script_constant_map** **(** **)** +Returns a dictionary containing constant names and their values. + ---- .. _class_Script_method_get_script_method_list: - :ref:`Array` **get_script_method_list** **(** **)** +Returns the list of methods in this ``Script``. + ---- .. _class_Script_method_get_script_property_list: - :ref:`Array` **get_script_property_list** **(** **)** +Returns the list of properties in this ``Script``. + ---- .. _class_Script_method_get_script_signal_list: - :ref:`Array` **get_script_signal_list** **(** **)** +Returns the list of user signals defined in this ``Script``. + ---- .. _class_Script_method_has_script_signal: -- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const +- :ref:`bool` **has_script_signal** **(** :ref:`StringName` signal_name **)** const Returns ``true`` if the script, or a base class, defines a signal with the given name. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 238f85f50..82942e818 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -11,7 +11,7 @@ ScriptEditor **Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +Godot editor's script editor. Methods ------- diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 25b4fad6e..436629617 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -18,7 +18,11 @@ A helper node for displaying scrollable elements such as lists. Description ----------- -A ScrollContainer node meant to contain a :ref:`Control` child. ScrollContainers will automatically create a scrollbar child (:ref:`HScrollBar`, :ref:`VScrollBar`, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the :ref:`Control.rect_min_size` of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set ``EXPAND`` on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension). +A ScrollContainer node meant to contain a :ref:`Control` child. + +ScrollContainers will automatically create a scrollbar child (:ref:`HScrollBar`, :ref:`VScrollBar`, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the :ref:`Control.rect_min_size` of the Control relative to the ScrollContainer. + +Works great with a :ref:`Panel` control. You can set ``EXPAND`` on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension). Properties ---------- diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index fb8cceea4..d28090888 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -26,26 +26,36 @@ Tutorials Methods ------- -+---------------------------------------+------------------------------------------------------+ -| :ref:`Error` | :ref:`post` **(** **)** | -+---------------------------------------+------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | -+---------------------------------------+------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------+ +| void | :ref:`post` **(** **)** | ++---------------------------------------+--------------------------------------------------------------+ +| :ref:`Error` | :ref:`try_wait` **(** **)** | ++---------------------------------------+--------------------------------------------------------------+ +| void | :ref:`wait` **(** **)** | ++---------------------------------------+--------------------------------------------------------------+ Method Descriptions ------------------- .. _class_Semaphore_method_post: -- :ref:`Error` **post** **(** **)** +- void **post** **(** **)** -Lowers the ``Semaphore``, allowing one more thread in. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_BUSY` otherwise. +Lowers the ``Semaphore``, allowing one more thread in. + +---- + +.. _class_Semaphore_method_try_wait: + +- :ref:`Error` **try_wait** **(** **)** + +Like :ref:`wait`, but won't block, so if the value is zero, fails immediately and returns :ref:`@GlobalScope.ERR_BUSY`. If non-zero, it returns :ref:`@GlobalScope.OK` to report success. ---- .. _class_Semaphore_method_wait: -- :ref:`Error` **wait** **(** **)** +- void **wait** **(** **)** -Tries to wait for the ``Semaphore``, if its value is zero, blocks until non-zero. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_BUSY` otherwise. +Waits for the ``Semaphore``, if its value is zero, blocks until non-zero. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index c1763e0b8..7c21efc36 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -37,15 +37,15 @@ Properties Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_default_texture_param` **(** :ref:`StringName` param **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`get_mode` **(** **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_param` **(** :ref:`StringName` name **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_param` **(** :ref:`StringName` param, :ref:`Texture2D` texture **)** | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -88,7 +88,7 @@ Method Descriptions .. _class_Shader_method_get_default_texture_param: -- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const +- :ref:`Texture2D` **get_default_texture_param** **(** :ref:`StringName` param **)** const Returns the texture that is set as default for the specified parameter. @@ -106,7 +106,7 @@ Returns the shader mode for the shader, either :ref:`MODE_CANVAS_ITEM` **has_param** **(** :ref:`String` name **)** const +- :ref:`bool` **has_param** **(** :ref:`StringName` name **)** const Returns ``true`` if the shader has this param defined as a uniform in its code. @@ -116,7 +116,7 @@ Returns ``true`` if the shader has this param defined as a uniform in its code. .. _class_Shader_method_set_default_texture_param: -- void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** +- void **set_default_texture_param** **(** :ref:`StringName` param, :ref:`Texture2D` texture **)** Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the :ref:`ShaderMaterial`. diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 2403f15d2..e3a4759a5 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -33,15 +33,15 @@ Properties Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`StringName` param **)** const | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_param` **(** :ref:`StringName` param, :ref:`Variant` value **)** | ++-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -63,7 +63,7 @@ Method Descriptions .. _class_ShaderMaterial_method_get_shader_param: -- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const +- :ref:`Variant` **get_shader_param** **(** :ref:`StringName` param **)** const Returns the current value set for this material of a uniform in the shader. @@ -87,7 +87,7 @@ Returns the default value of the material property with given ``name``. .. _class_ShaderMaterial_method_set_shader_param: -- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** +- void **set_shader_param** **(** :ref:`StringName` param, :ref:`Variant` value **)** Changes the value set for this material of a uniform in the shader. **Note:** ``param`` must match the name of the uniform in the code exactly. diff --git a/classes/class_shape.rst b/classes/class_shape.rst index e663c41b9..79b3a2a08 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -11,7 +11,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`BoxShape`, :ref:`CapsuleShape`, :ref:`ConcavePolygonShape`, :ref:`ConvexPolygonShape`, :ref:`CylinderShape`, :ref:`HeightMapShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`SphereShape` +**Inherited By:** :ref:`BoxShape`, :ref:`CapsuleShape`, :ref:`ConcavePolygonShape`, :ref:`ConvexPolygonShape`, :ref:`CylinderShape`, :ref:`HeightMapShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`WorldMarginShape` Base class for all 3D shape resources. diff --git a/classes/class_signal.rst b/classes/class_signal.rst new file mode 100644 index 000000000..9c7130a6e --- /dev/null +++ b/classes/class_signal.rst @@ -0,0 +1,117 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Signal.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Signal: + +Signal +====== + +Class representing a signal defined in an object. + +Methods +------- + ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Signal` | :ref:`Signal` **(** :ref:`Object` object, :ref:`StringName` signal_name **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`Callable` callable, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`Callable` callable **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit` **(** ... **)** vararg | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connections` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_name` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_object` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_object_id` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`Callable` callable **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_null` **(** **)** | ++-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Signal_method_Signal: + +- :ref:`Signal` **Signal** **(** :ref:`Object` object, :ref:`StringName` signal_name **)** + +Creates a new signal named ``signal_name`` in the given object. + +---- + +.. _class_Signal_method_connect: + +- :ref:`int` **connect** **(** :ref:`Callable` callable, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** + +Connects this signal to the specified :ref:`Callable`, optionally providing binds and connection flags. + +---- + +.. _class_Signal_method_disconnect: + +- void **disconnect** **(** :ref:`Callable` callable **)** + +Disconnects this signal from the specified :ref:`Callable`. + +---- + +.. _class_Signal_method_emit: + +- void **emit** **(** ... **)** vararg + +Emits this signal to all connected objects. + +---- + +.. _class_Signal_method_get_connections: + +- :ref:`Array` **get_connections** **(** **)** + +Returns the list of :ref:`Callable`\ s connected to this signal. + +---- + +.. _class_Signal_method_get_name: + +- :ref:`StringName` **get_name** **(** **)** + +Returns the name of this signal. + +---- + +.. _class_Signal_method_get_object: + +- :ref:`Object` **get_object** **(** **)** + +Returns the object emitting this signal. + +---- + +.. _class_Signal_method_get_object_id: + +- :ref:`int` **get_object_id** **(** **)** + +Returns the ID of the object emitting this signal (see :ref:`Object.get_instance_id`). + +---- + +.. _class_Signal_method_is_connected: + +- :ref:`bool` **is_connected** **(** :ref:`Callable` callable **)** + +Returns ``true`` if the specified :ref:`Callable` is connected to this signal. + +---- + +.. _class_Signal_method_is_null: + +- :ref:`bool` **is_null** **(** **)** + diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 266999b74..ad5a3d6e5 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -22,6 +22,13 @@ The overall transform of a bone with respect to the skeleton is determined by th Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. +Properties +---------- + ++-------------------------+-------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`animate_physical_bones` | ``true`` | ++-------------------------+-------------------------------------------------------------------------------+----------+ + Methods ------- @@ -88,6 +95,21 @@ Constants - **NOTIFICATION_UPDATE_SKELETON** = **50** +Property Descriptions +--------------------- + +.. _class_Skeleton_property_animate_physical_bones: + +- :ref:`bool` **animate_physical_bones** + ++-----------+-----------------------------------+ +| *Default* | ``true`` | ++-----------+-----------------------------------+ +| *Setter* | set_animate_physical_bones(value) | ++-----------+-----------------------------------+ +| *Getter* | get_animate_physical_bones() | ++-----------+-----------------------------------+ + Method Descriptions ------------------- diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 7cc5958af..413ead89d 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -13,6 +13,11 @@ Skeleton2D Skeleton for 2D characters and animated objects. +Description +----------- + +Skeleton2D parents a hierarchy of :ref:`Bone2D` objects. It is a requirement of :ref:`Bone2D`. Skeleton2D holds a reference to the rest pose of its children and acts as a single point of access to its bones. + Tutorials --------- @@ -43,13 +48,15 @@ Method Descriptions - :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** +Returns a :ref:`Bone2D` from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter ``idx``. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. + ---- .. _class_Skeleton2D_method_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const -Returns the amount of bones in the skeleton. +Returns the number of :ref:`Bone2D` nodes in the node hierarchy parented by Skeleton2D. ---- @@ -57,3 +64,5 @@ Returns the amount of bones in the skeleton. - :ref:`RID` **get_skeleton** **(** **)** const +Returns the :ref:`RID` of a Skeleton2D instance. + diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index d80cd8227..da9567395 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -16,27 +16,27 @@ SkeletonIK Properties ---------- -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`interpolation` | ``1.0`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`magnet` | ``Vector3( 0, 0, 0 )`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`int` | :ref:`max_iterations` | ``10`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`min_distance` | ``0.01`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`override_tip_basis` | ``true`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`String` | :ref:`root_bone` | ``""`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform` | :ref:`target` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`NodePath` | :ref:`target_node` | ``NodePath("")`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`String` | :ref:`tip_bone` | ``""`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`use_magnet` | ``false`` | -+-----------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`interpolation` | ``1.0`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Vector3` | :ref:`magnet` | ``Vector3( 0, 0, 0 )`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`int` | :ref:`max_iterations` | ``10`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`float` | :ref:`min_distance` | ``0.01`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`override_tip_basis` | ``true`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`StringName` | :ref:`root_bone` | ``@""`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform` | :ref:`target` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`NodePath` | :ref:`target_node` | ``NodePath("")`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`StringName` | :ref:`tip_bone` | ``@""`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`use_magnet` | ``false`` | ++-------------------------------------+-------------------------------------------------------------------------+-----------------------------------------------------+ Methods ------- @@ -126,10 +126,10 @@ Property Descriptions .. _class_SkeletonIK_property_root_bone: -- :ref:`String` **root_bone** +- :ref:`StringName` **root_bone** +-----------+----------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+----------------------+ | *Setter* | set_root_bone(value) | +-----------+----------------------+ @@ -168,10 +168,10 @@ Property Descriptions .. _class_SkeletonIK_property_tip_bone: -- :ref:`String` **tip_bone** +- :ref:`StringName` **tip_bone** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_tip_bone(value) | +-----------+---------------------+ diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 1bf489b4b..4cfee64cf 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -16,23 +16,27 @@ Skin Methods ------- -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bind` **(** :ref:`int` bone, :ref:`Transform` pose **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_binds` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bind_count` **(** **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_bone` **(** :ref:`int` bind_index, :ref:`int` bone **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_count` **(** :ref:`int` bind_count **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_pose` **(** :ref:`int` bind_index, :ref:`Transform` pose **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bind` **(** :ref:`int` bone, :ref:`Transform` pose **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_binds` **(** **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bind_bone` **(** :ref:`int` bind_index **)** const | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bind_count` **(** **)** const | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_bind_name` **(** :ref:`int` bind_index **)** const | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_bind_pose` **(** :ref:`int` bind_index **)** const | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_bone` **(** :ref:`int` bind_index, :ref:`int` bone **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_count` **(** :ref:`int` bind_count **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_name` **(** :ref:`int` bind_index, :ref:`StringName` name **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bind_pose` **(** :ref:`int` bind_index, :ref:`Transform` pose **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -61,6 +65,12 @@ Method Descriptions ---- +.. _class_Skin_method_get_bind_name: + +- :ref:`StringName` **get_bind_name** **(** :ref:`int` bind_index **)** const + +---- + .. _class_Skin_method_get_bind_pose: - :ref:`Transform` **get_bind_pose** **(** :ref:`int` bind_index **)** const @@ -79,6 +89,12 @@ Method Descriptions ---- +.. _class_Skin_method_set_bind_name: + +- void **set_bind_name** **(** :ref:`int` bind_index, :ref:`StringName` name **)** + +---- + .. _class_Skin_method_set_bind_pose: - void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform` pose **)** diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 42decb22f..aadb6e369 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -23,6 +23,8 @@ The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky Properties ---------- ++--------------------------------------------+--------------------------------------------------------+-------+ +| :ref:`ProcessMode` | :ref:`process_mode` | ``0`` | +--------------------------------------------+--------------------------------------------------------+-------+ | :ref:`RadianceSize` | :ref:`radiance_size` | ``2`` | +--------------------------------------------+--------------------------------------------------------+-------+ @@ -66,9 +68,41 @@ enum **RadianceSize**: - **RADIANCE_SIZE_MAX** = **7** --- Represents the size of the :ref:`RadianceSize` enum. +---- + +.. _enum_Sky_ProcessMode: + +.. _class_Sky_constant_PROCESS_MODE_QUALITY: + +.. _class_Sky_constant_PROCESS_MODE_REALTIME: + +enum **ProcessMode**: + +- **PROCESS_MODE_QUALITY** = **0** --- Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than :ref:`PROCESS_MODE_REALTIME` but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. + +- **PROCESS_MODE_REALTIME** = **1** --- Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times. + +**Note:** The fast filtering algorithm is limited to 128x128 cubemaps, so :ref:`radiance_size` must be set to :ref:`RADIANCE_SIZE_128`. + Property Descriptions --------------------- +.. _class_Sky_property_process_mode: + +- :ref:`ProcessMode` **process_mode** + ++-----------+-------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------+ +| *Setter* | set_process_mode(value) | ++-----------+-------------------------+ +| *Getter* | get_process_mode() | ++-----------+-------------------------+ + +Sets the method for generating the radiance map from the sky. The radiance map is a cubemap with increasingly blurry versions of the sky corresponding to different levels of roughness. Radiance maps can be expensive to calculate. See :ref:`ProcessMode` for options. + +---- + .. _class_Sky_property_radiance_size: - :ref:`RadianceSize` **radiance_size** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 5461e203f..0a987c57d 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -11,7 +11,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:`GridMap`, :ref:`Joint`, :ref:`Listener`, :ref:`Navigation`, :ref:`NavigationMeshInstance`, :ref:`Path`, :ref:`PathFollow`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RayCast`, :ref:`RemoteTransform`, :ref:`Skeleton`, :ref:`SpringArm`, :ref:`VehicleWheel`, :ref:`VisibilityNotifier`, :ref:`VisualInstance` +**Inherited By:** :ref:`ARVRAnchor`, :ref:`ARVRController`, :ref:`ARVROrigin`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment`, :ref:`Camera`, :ref:`CollisionObject`, :ref:`CollisionPolygon`, :ref:`CollisionShape`, :ref:`GridMap`, :ref:`Joint`, :ref:`Listener`, :ref:`Navigation`, :ref:`NavigationRegion`, :ref:`Path`, :ref:`PathFollow`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RayCast`, :ref:`RemoteTransform`, :ref:`Skeleton`, :ref:`SpringArm`, :ref:`VehicleWheel`, :ref:`VisibilityNotifier`, :ref:`VisualInstance` Most basic 3D game object, parent of all 3D-related nodes. diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst deleted file mode 100644 index 501c914cc..000000000 --- a/classes/class_spatialmaterial.rst +++ /dev/null @@ -1,2256 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the SpatialMaterial.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_SpatialMaterial: - -SpatialMaterial -=============== - -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -Default 3D rendering material. - -Description ------------ - -This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details. - -Tutorials ---------- - -- :doc:`../tutorials/3d/spatial_material` - -Properties ----------- - -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ -| :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:`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_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` | ``1.0`` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ -| :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` | ``1.0`` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`vertex_color_is_srgb` | ``false`` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`vertex_color_use_as_albedo` | ``false`` | -+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------+-------------------------+ - -Methods -------- - -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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 **)** | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_SpatialMaterial_TextureParam: - -.. _class_SpatialMaterial_constant_TEXTURE_ALBEDO: - -.. _class_SpatialMaterial_constant_TEXTURE_METALLIC: - -.. _class_SpatialMaterial_constant_TEXTURE_ROUGHNESS: - -.. _class_SpatialMaterial_constant_TEXTURE_EMISSION: - -.. _class_SpatialMaterial_constant_TEXTURE_NORMAL: - -.. _class_SpatialMaterial_constant_TEXTURE_RIM: - -.. _class_SpatialMaterial_constant_TEXTURE_CLEARCOAT: - -.. _class_SpatialMaterial_constant_TEXTURE_FLOWMAP: - -.. _class_SpatialMaterial_constant_TEXTURE_AMBIENT_OCCLUSION: - -.. _class_SpatialMaterial_constant_TEXTURE_DEPTH: - -.. _class_SpatialMaterial_constant_TEXTURE_SUBSURFACE_SCATTERING: - -.. _class_SpatialMaterial_constant_TEXTURE_TRANSMISSION: - -.. _class_SpatialMaterial_constant_TEXTURE_REFRACTION: - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_MASK: - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_ALBEDO: - -.. _class_SpatialMaterial_constant_TEXTURE_DETAIL_NORMAL: - -.. _class_SpatialMaterial_constant_TEXTURE_MAX: - -enum **TextureParam**: - -- **TEXTURE_ALBEDO** = **0** --- Texture specifying per-pixel color. - -- **TEXTURE_METALLIC** = **1** --- Texture specifying per-pixel metallic value. - -- **TEXTURE_ROUGHNESS** = **2** --- Texture specifying per-pixel roughness value. - -- **TEXTURE_EMISSION** = **3** --- Texture specifying per-pixel emission color. - -- **TEXTURE_NORMAL** = **4** --- Texture specifying per-pixel normal vector. - -- **TEXTURE_RIM** = **5** --- Texture specifying per-pixel rim value. - -- **TEXTURE_CLEARCOAT** = **6** --- Texture specifying per-pixel clearcoat value. - -- **TEXTURE_FLOWMAP** = **7** --- Texture specifying per-pixel flowmap direction for use with :ref:`anisotropy`. - -- **TEXTURE_AMBIENT_OCCLUSION** = **8** --- Texture specifying per-pixel ambient occlusion value. - -- **TEXTURE_DEPTH** = **9** --- Texture specifying per-pixel depth. - -- **TEXTURE_SUBSURFACE_SCATTERING** = **10** --- Texture specifying per-pixel subsurface scattering. - -- **TEXTURE_TRANSMISSION** = **11** --- Texture specifying per-pixel transmission color. - -- **TEXTURE_REFRACTION** = **12** --- Texture specifying per-pixel refraction strength. - -- **TEXTURE_DETAIL_MASK** = **13** --- Texture specifying per-pixel detail mask blending value. - -- **TEXTURE_DETAIL_ALBEDO** = **14** --- Texture specifying per-pixel detail color. - -- **TEXTURE_DETAIL_NORMAL** = **15** --- Texture specifying per-pixel detail normal. - -- **TEXTURE_MAX** = **16** --- Represents the size of the :ref:`TextureParam` enum. - ----- - -.. _enum_SpatialMaterial_DetailUV: - -.. _class_SpatialMaterial_constant_DETAIL_UV_1: - -.. _class_SpatialMaterial_constant_DETAIL_UV_2: - -enum **DetailUV**: - -- **DETAIL_UV_1** = **0** --- Use ``UV`` with the detail texture. - -- **DETAIL_UV_2** = **1** --- Use ``UV2`` with the detail texture. - ----- - -.. _enum_SpatialMaterial_Feature: - -.. _class_SpatialMaterial_constant_FEATURE_TRANSPARENT: - -.. _class_SpatialMaterial_constant_FEATURE_EMISSION: - -.. _class_SpatialMaterial_constant_FEATURE_NORMAL_MAPPING: - -.. _class_SpatialMaterial_constant_FEATURE_RIM: - -.. _class_SpatialMaterial_constant_FEATURE_CLEARCOAT: - -.. _class_SpatialMaterial_constant_FEATURE_ANISOTROPY: - -.. _class_SpatialMaterial_constant_FEATURE_AMBIENT_OCCLUSION: - -.. _class_SpatialMaterial_constant_FEATURE_DEPTH_MAPPING: - -.. _class_SpatialMaterial_constant_FEATURE_SUBSURACE_SCATTERING: - -.. _class_SpatialMaterial_constant_FEATURE_TRANSMISSION: - -.. _class_SpatialMaterial_constant_FEATURE_REFRACTION: - -.. _class_SpatialMaterial_constant_FEATURE_DETAIL: - -.. _class_SpatialMaterial_constant_FEATURE_MAX: - -enum **Feature**: - -- **FEATURE_TRANSPARENT** = **0** --- Constant for setting :ref:`flags_transparent`. - -- **FEATURE_EMISSION** = **1** --- Constant for setting :ref:`emission_enabled`. - -- **FEATURE_NORMAL_MAPPING** = **2** --- Constant for setting :ref:`normal_enabled`. - -- **FEATURE_RIM** = **3** --- Constant for setting :ref:`rim_enabled`. - -- **FEATURE_CLEARCOAT** = **4** --- Constant for setting :ref:`clearcoat_enabled`. - -- **FEATURE_ANISOTROPY** = **5** --- Constant for setting :ref:`anisotropy_enabled`. - -- **FEATURE_AMBIENT_OCCLUSION** = **6** --- Constant for setting :ref:`ao_enabled`. - -- **FEATURE_DEPTH_MAPPING** = **7** --- Constant for setting :ref:`depth_enabled`. - -- **FEATURE_SUBSURACE_SCATTERING** = **8** --- Constant for setting :ref:`subsurf_scatter_enabled`. - -- **FEATURE_TRANSMISSION** = **9** --- Constant for setting :ref:`transmission_enabled`. - -- **FEATURE_REFRACTION** = **10** --- Constant for setting :ref:`refraction_enabled`. - -- **FEATURE_DETAIL** = **11** --- Constant for setting :ref:`detail_enabled`. - -- **FEATURE_MAX** = **12** --- Represents the size of the :ref:`Feature` enum. - ----- - -.. _enum_SpatialMaterial_BlendMode: - -.. _class_SpatialMaterial_constant_BLEND_MODE_MIX: - -.. _class_SpatialMaterial_constant_BLEND_MODE_ADD: - -.. _class_SpatialMaterial_constant_BLEND_MODE_SUB: - -.. _class_SpatialMaterial_constant_BLEND_MODE_MUL: - -enum **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. - -- **BLEND_MODE_ADD** = **1** --- The color of the object is added to the background. - -- **BLEND_MODE_SUB** = **2** --- The color of the object is subtracted from the background. - -- **BLEND_MODE_MUL** = **3** --- The color of the object is multiplied by the background. - ----- - -.. _enum_SpatialMaterial_DepthDrawMode: - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_OPAQUE_ONLY: - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALWAYS: - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_DISABLED: - -.. _class_SpatialMaterial_constant_DEPTH_DRAW_ALPHA_OPAQUE_PREPASS: - -enum **DepthDrawMode**: - -- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects. - -- **DEPTH_DRAW_ALWAYS** = **1** --- Depth draw is calculated for both opaque and transparent objects. - -- **DEPTH_DRAW_DISABLED** = **2** --- No depth draw. - -- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** --- For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn. - ----- - -.. _enum_SpatialMaterial_CullMode: - -.. _class_SpatialMaterial_constant_CULL_BACK: - -.. _class_SpatialMaterial_constant_CULL_FRONT: - -.. _class_SpatialMaterial_constant_CULL_DISABLED: - -enum **CullMode**: - -- **CULL_BACK** = **0** --- Default cull mode. The back of the object is culled when not visible. - -- **CULL_FRONT** = **1** --- The front of the object is culled when not visible. - -- **CULL_DISABLED** = **2** --- No culling is performed. - ----- - -.. _enum_SpatialMaterial_Flags: - -.. _class_SpatialMaterial_constant_FLAG_UNSHADED: - -.. _class_SpatialMaterial_constant_FLAG_USE_VERTEX_LIGHTING: - -.. _class_SpatialMaterial_constant_FLAG_DISABLE_DEPTH_TEST: - -.. _class_SpatialMaterial_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR: - -.. _class_SpatialMaterial_constant_FLAG_SRGB_VERTEX_COLOR: - -.. _class_SpatialMaterial_constant_FLAG_USE_POINT_SIZE: - -.. _class_SpatialMaterial_constant_FLAG_FIXED_SIZE: - -.. _class_SpatialMaterial_constant_FLAG_BILLBOARD_KEEP_SCALE: - -.. _class_SpatialMaterial_constant_FLAG_UV1_USE_TRIPLANAR: - -.. _class_SpatialMaterial_constant_FLAG_UV2_USE_TRIPLANAR: - -.. _class_SpatialMaterial_constant_FLAG_AO_ON_UV2: - -.. _class_SpatialMaterial_constant_FLAG_EMISSION_ON_UV2: - -.. _class_SpatialMaterial_constant_FLAG_USE_ALPHA_SCISSOR: - -.. _class_SpatialMaterial_constant_FLAG_TRIPLANAR_USE_WORLD: - -.. _class_SpatialMaterial_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB: - -.. _class_SpatialMaterial_constant_FLAG_DONT_RECEIVE_SHADOWS: - -.. _class_SpatialMaterial_constant_FLAG_DISABLE_AMBIENT_LIGHT: - -.. _class_SpatialMaterial_constant_FLAG_ENSURE_CORRECT_NORMALS: - -.. _class_SpatialMaterial_constant_FLAG_USE_SHADOW_TO_OPACITY: - -.. _class_SpatialMaterial_constant_FLAG_MAX: - -enum **Flags**: - -- **FLAG_UNSHADED** = **0** --- No lighting is used on the object. Color comes directly from ``ALBEDO``. - -- **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. - -- **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. - -- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **3** --- Set ``ALBEDO`` to the per-vertex color specified in the mesh. - -- **FLAG_SRGB_VERTEX_COLOR** = **4** --- Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer. - -- **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``. - -- **FLAG_FIXED_SIZE** = **6** --- Object is scaled by depth so that it always appears the same size on screen. - -- **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`. - -- **FLAG_UV1_USE_TRIPLANAR** = **8** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV``. - -- **FLAG_UV2_USE_TRIPLANAR** = **9** --- Use triplanar texture lookup for all texture lookups that would normally use ``UV2``. - -- **FLAG_AO_ON_UV2** = **11** --- Use ``UV2`` coordinates to look up from the :ref:`ao_texture`. - -- **FLAG_EMISSION_ON_UV2** = **12** --- Use ``UV2`` coordinates to look up from the :ref:`emission_texture`. - -- **FLAG_USE_ALPHA_SCISSOR** = **13** --- Use alpha scissor. Set by :ref:`params_use_alpha_scissor`. - -- **FLAG_TRIPLANAR_USE_WORLD** = **10** --- Use world coordinates in the triplanar texture lookup instead of local coordinates. - -- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **14** --- Forces the shader to convert albedo from sRGB space to linear space. - -- **FLAG_DONT_RECEIVE_SHADOWS** = **15** --- Disables receiving shadows from other objects. - -- **FLAG_DISABLE_AMBIENT_LIGHT** = **17** --- Disables receiving ambient light. - -- **FLAG_ENSURE_CORRECT_NORMALS** = **16** --- Ensures that normals appear correct, even with non-uniform scaling. - -- **FLAG_USE_SHADOW_TO_OPACITY** = **18** --- Enables the shadow to opacity feature. - -- **FLAG_MAX** = **19** --- Represents the size of the :ref:`Flags` enum. - ----- - -.. _enum_SpatialMaterial_DiffuseMode: - -.. _class_SpatialMaterial_constant_DIFFUSE_BURLEY: - -.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT: - -.. _class_SpatialMaterial_constant_DIFFUSE_LAMBERT_WRAP: - -.. _class_SpatialMaterial_constant_DIFFUSE_OREN_NAYAR: - -.. _class_SpatialMaterial_constant_DIFFUSE_TOON: - -enum **DiffuseMode**: - -- **DIFFUSE_BURLEY** = **0** --- Default diffuse scattering algorithm. - -- **DIFFUSE_LAMBERT** = **1** --- Diffuse scattering ignores roughness. - -- **DIFFUSE_LAMBERT_WRAP** = **2** --- Extends Lambert to cover more than 90 degrees when roughness increases. - -- **DIFFUSE_OREN_NAYAR** = **3** --- Attempts to use roughness to emulate microsurfacing. - -- **DIFFUSE_TOON** = **4** --- Uses a hard cut for lighting, with smoothing affected by roughness. - ----- - -.. _enum_SpatialMaterial_SpecularMode: - -.. _class_SpatialMaterial_constant_SPECULAR_SCHLICK_GGX: - -.. _class_SpatialMaterial_constant_SPECULAR_BLINN: - -.. _class_SpatialMaterial_constant_SPECULAR_PHONG: - -.. _class_SpatialMaterial_constant_SPECULAR_TOON: - -.. _class_SpatialMaterial_constant_SPECULAR_DISABLED: - -enum **SpecularMode**: - -- **SPECULAR_SCHLICK_GGX** = **0** --- Default specular blob. - -- **SPECULAR_BLINN** = **1** --- Older specular algorithm, included for compatibility. - -- **SPECULAR_PHONG** = **2** --- Older specular algorithm, included for compatibility. - -- **SPECULAR_TOON** = **3** --- Toon blob which changes size based on roughness. - -- **SPECULAR_DISABLED** = **4** --- No specular blob. - ----- - -.. _enum_SpatialMaterial_BillboardMode: - -.. _class_SpatialMaterial_constant_BILLBOARD_DISABLED: - -.. _class_SpatialMaterial_constant_BILLBOARD_ENABLED: - -.. _class_SpatialMaterial_constant_BILLBOARD_FIXED_Y: - -.. _class_SpatialMaterial_constant_BILLBOARD_PARTICLES: - -enum **BillboardMode**: - -- **BILLBOARD_DISABLED** = **0** --- Billboard mode is disabled. - -- **BILLBOARD_ENABLED** = **1** --- The object's Z axis will always face the camera. - -- **BILLBOARD_FIXED_Y** = **2** --- The object's X axis will always face the camera. - -- **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. - ----- - -.. _enum_SpatialMaterial_TextureChannel: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_RED: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GREEN: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_BLUE: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_ALPHA: - -.. _class_SpatialMaterial_constant_TEXTURE_CHANNEL_GRAYSCALE: - -enum **TextureChannel**: - -- **TEXTURE_CHANNEL_RED** = **0** --- Used to read from the red channel of a texture. - -- **TEXTURE_CHANNEL_GREEN** = **1** --- Used to read from the green channel of a texture. - -- **TEXTURE_CHANNEL_BLUE** = **2** --- Used to read from the blue channel of a texture. - -- **TEXTURE_CHANNEL_ALPHA** = **3** --- Used to read from the alpha channel of a texture. - -- **TEXTURE_CHANNEL_GRAYSCALE** = **4** --- Currently unused. - ----- - -.. _enum_SpatialMaterial_EmissionOperator: - -.. _class_SpatialMaterial_constant_EMISSION_OP_ADD: - -.. _class_SpatialMaterial_constant_EMISSION_OP_MULTIPLY: - -enum **EmissionOperator**: - -- **EMISSION_OP_ADD** = **0** --- Adds the emission color to the color from the emission texture. - -- **EMISSION_OP_MULTIPLY** = **1** --- Multiplies the emission color by the color from the emission texture. - ----- - -.. _enum_SpatialMaterial_DistanceFadeMode: - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_DISABLED: - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_ALPHA: - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_PIXEL_DITHER: - -.. _class_SpatialMaterial_constant_DISTANCE_FADE_OBJECT_DITHER: - -enum **DistanceFadeMode**: - -- **DISTANCE_FADE_DISABLED** = **0** --- Do not use distance fade. - -- **DISTANCE_FADE_PIXEL_ALPHA** = **1** --- Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel. - -- **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`. - -- **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`. - -Property Descriptions ---------------------- - -.. _class_SpatialMaterial_property_albedo_color: - -- :ref:`Color` **albedo_color** - -+-----------+-------------------------+ -| *Default* | ``Color( 1, 1, 1, 1 )`` | -+-----------+-------------------------+ -| *Setter* | set_albedo(value) | -+-----------+-------------------------+ -| *Getter* | get_albedo() | -+-----------+-------------------------+ - -The material's base color. - ----- - -.. _class_SpatialMaterial_property_albedo_texture: - -- :ref:`Texture` **albedo_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture to multiply by :ref:`albedo_color`. Used for basic texturing of objects. - ----- - -.. _class_SpatialMaterial_property_anisotropy: - -- :ref:`float` **anisotropy** - -+----------+-----------------------+ -| *Setter* | set_anisotropy(value) | -+----------+-----------------------+ -| *Getter* | get_anisotropy() | -+----------+-----------------------+ - -The strength of the anisotropy effect. - ----- - -.. _class_SpatialMaterial_property_anisotropy_enabled: - -- :ref:`bool` **anisotropy_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Mesh tangents are needed for this to work. If the mesh does not contain tangents the anisotropy effect will appear broken. - ----- - -.. _class_SpatialMaterial_property_anisotropy_flowmap: - -- :ref:`Texture` **anisotropy_flowmap** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that offsets the tangent map for anisotropy calculations. - ----- - -.. _class_SpatialMaterial_property_ao_enabled: - -- :ref:`bool` **ao_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture`. - ----- - -.. _class_SpatialMaterial_property_ao_light_affect: - -- :ref:`float` **ao_light_affect** - -+----------+----------------------------+ -| *Setter* | set_ao_light_affect(value) | -+----------+----------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_ao_on_uv2: - -- :ref:`bool` **ao_on_uv2** - -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ - -If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture`. - ----- - -.. _class_SpatialMaterial_property_ao_texture: - -- :ref:`Texture` **ao_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that defines the amount of ambient occlusion for a given point on the object. - ----- - -.. _class_SpatialMaterial_property_ao_texture_channel: - -- :ref:`TextureChannel` **ao_texture_channel** - -+----------+-------------------------------+ -| *Setter* | set_ao_texture_channel(value) | -+----------+-------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_clearcoat: - -- :ref:`float` **clearcoat** - -+----------+----------------------+ -| *Setter* | set_clearcoat(value) | -+----------+----------------------+ -| *Getter* | get_clearcoat() | -+----------+----------------------+ - -Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect. - ----- - -.. _class_SpatialMaterial_property_clearcoat_enabled: - -- :ref:`bool` **clearcoat_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_clearcoat_gloss: - -- :ref:`float` **clearcoat_gloss** - -+----------+----------------------------+ -| *Setter* | set_clearcoat_gloss(value) | -+----------+----------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_clearcoat_texture: - -- :ref:`Texture` **clearcoat_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_depth_deep_parallax: - -- :ref:`bool` **depth_deep_parallax** - -+----------+----------------------------------+ -| *Setter* | set_depth_deep_parallax(value) | -+----------+----------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_depth_enabled: - -- :ref:`bool` **depth_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also :ref:`normal_enabled`. - ----- - -.. _class_SpatialMaterial_property_depth_flip_binormal: - -- :ref:`bool` **depth_flip_binormal** - -+----------+----------------------------------------------+ -| *Setter* | set_depth_deep_parallax_flip_binormal(value) | -+----------+----------------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_depth_flip_tangent: - -- :ref:`bool` **depth_flip_tangent** - -+----------+---------------------------------------------+ -| *Setter* | set_depth_deep_parallax_flip_tangent(value) | -+----------+---------------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_depth_max_layers: - -- :ref:`int` **depth_max_layers** - -+----------+-------------------------------------------+ -| *Setter* | set_depth_deep_parallax_max_layers(value) | -+----------+-------------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_depth_min_layers: - -- :ref:`int` **depth_min_layers** - -+----------+-------------------------------------------+ -| *Setter* | set_depth_deep_parallax_min_layers(value) | -+----------+-------------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_depth_scale: - -- :ref:`float` **depth_scale** - -+----------+------------------------+ -| *Setter* | set_depth_scale(value) | -+----------+------------------------+ -| *Getter* | get_depth_scale() | -+----------+------------------------+ - -Scales the depth offset effect. A higher number will create a larger depth. - ----- - -.. _class_SpatialMaterial_property_depth_texture: - -- :ref:`Texture` **depth_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to determine depth at a given pixel. Depth is always stored in the red channel. - ----- - -.. _class_SpatialMaterial_property_detail_albedo: - -- :ref:`Texture` **detail_albedo** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that specifies the color of the detail overlay. - ----- - -.. _class_SpatialMaterial_property_detail_blend_mode: - -- :ref:`BlendMode` **detail_blend_mode** - -+----------+------------------------------+ -| *Setter* | set_detail_blend_mode(value) | -+----------+------------------------------+ -| *Getter* | get_detail_blend_mode() | -+----------+------------------------------+ - -Specifies how the :ref:`detail_albedo` should blend with the current ``ALBEDO``. See :ref:`BlendMode` for options. - ----- - -.. _class_SpatialMaterial_property_detail_enabled: - -- :ref:`bool` **detail_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_detail_mask: - -- :ref:`Texture` **detail_mask** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to specify how the detail textures get blended with the base textures. - ----- - -.. _class_SpatialMaterial_property_detail_normal: - -- :ref:`Texture` **detail_normal** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that specifies the per-pixel normal of the detail overlay. - ----- - -.. _class_SpatialMaterial_property_detail_uv_layer: - -- :ref:`DetailUV` **detail_uv_layer** - -+----------+----------------------+ -| *Setter* | set_detail_uv(value) | -+----------+----------------------+ -| *Getter* | get_detail_uv() | -+----------+----------------------+ - -Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV` for options. - ----- - -.. _class_SpatialMaterial_property_distance_fade_max_distance: - -- :ref:`float` **distance_fade_max_distance** - -+----------+---------------------------------------+ -| *Setter* | set_distance_fade_max_distance(value) | -+----------+---------------------------------------+ -| *Getter* | get_distance_fade_max_distance() | -+----------+---------------------------------------+ - -Distance at which the object fades fully and is no longer visible. - ----- - -.. _class_SpatialMaterial_property_distance_fade_min_distance: - -- :ref:`float` **distance_fade_min_distance** - -+----------+---------------------------------------+ -| *Setter* | set_distance_fade_min_distance(value) | -+----------+---------------------------------------+ -| *Getter* | get_distance_fade_min_distance() | -+----------+---------------------------------------+ - -Distance at which the object starts to fade. If the object is less than this distance away it will appear normal. - ----- - -.. _class_SpatialMaterial_property_distance_fade_mode: - -- :ref:`DistanceFadeMode` **distance_fade_mode** - -+-----------+--------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------+ -| *Setter* | set_distance_fade(value) | -+-----------+--------------------------+ -| *Getter* | get_distance_fade() | -+-----------+--------------------------+ - -Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode`\ s. - ----- - -.. _class_SpatialMaterial_property_emission: - -- :ref:`Color` **emission** - -+----------+---------------------+ -| *Setter* | set_emission(value) | -+----------+---------------------+ -| *Getter* | get_emission() | -+----------+---------------------+ - -The emitted light's color. See :ref:`emission_enabled`. - ----- - -.. _class_SpatialMaterial_property_emission_enabled: - -- :ref:`bool` **emission_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_emission_energy: - -- :ref:`float` **emission_energy** - -+----------+----------------------------+ -| *Setter* | set_emission_energy(value) | -+----------+----------------------------+ -| *Getter* | get_emission_energy() | -+----------+----------------------------+ - -The emitted light's strength. See :ref:`emission_enabled`. - ----- - -.. _class_SpatialMaterial_property_emission_on_uv2: - -- :ref:`bool` **emission_on_uv2** - -+----------+-----------------+ -| *Setter* | set_flag(value) | -+----------+-----------------+ -| *Getter* | get_flag() | -+----------+-----------------+ - -Use ``UV2`` to read from the :ref:`emission_texture`. - ----- - -.. _class_SpatialMaterial_property_emission_operator: - -- :ref:`EmissionOperator` **emission_operator** - -+----------+------------------------------+ -| *Setter* | set_emission_operator(value) | -+----------+------------------------------+ -| *Getter* | get_emission_operator() | -+----------+------------------------------+ - -Sets how :ref:`emission` interacts with :ref:`emission_texture`. Can either add or multiply. See :ref:`EmissionOperator` for options. - ----- - -.. _class_SpatialMaterial_property_emission_texture: - -- :ref:`Texture` **emission_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that specifies how much surface emits light at a given point. - ----- - -.. _class_SpatialMaterial_property_flags_albedo_tex_force_srgb: - -- :ref:`bool` **flags_albedo_tex_force_srgb** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -Forces a conversion of the :ref:`albedo_texture` from sRGB space to linear space. - ----- - -.. _class_SpatialMaterial_property_flags_disable_ambient_light: - -- :ref:`bool` **flags_disable_ambient_light** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the object receives no ambient light. - ----- - -.. _class_SpatialMaterial_property_flags_do_not_receive_shadows: - -- :ref:`bool` **flags_do_not_receive_shadows** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the object receives no shadow that would otherwise be cast onto it. - ----- - -.. _class_SpatialMaterial_property_flags_ensure_correct_normals: - -- :ref:`bool` **flags_ensure_correct_normals** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_flags_fixed_size: - -- :ref:`bool` **flags_fixed_size** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the object is rendered at the same size regardless of distance. - ----- - -.. _class_SpatialMaterial_property_flags_no_depth_test: - -- :ref:`bool` **flags_no_depth_test** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, depth testing is disabled and the object will be drawn in render order. - ----- - -.. _class_SpatialMaterial_property_flags_transparent: - -- :ref:`bool` **flags_transparent** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, transparency is enabled on the body. See also :ref:`params_blend_mode`. - ----- - -.. _class_SpatialMaterial_property_flags_unshaded: - -- :ref:`bool` **flags_unshaded** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the object is unaffected by lighting. - ----- - -.. _class_SpatialMaterial_property_flags_use_point_size: - -- :ref:`bool` **flags_use_point_size** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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`. - ----- - -.. _class_SpatialMaterial_property_flags_use_shadow_to_opacity: - -- :ref:`bool` **flags_use_shadow_to_opacity** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_flags_vertex_lighting: - -- :ref:`bool` **flags_vertex_lighting** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. - ----- - -.. _class_SpatialMaterial_property_flags_world_triplanar: - -- :ref:`bool` **flags_world_triplanar** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. - ----- - -.. _class_SpatialMaterial_property_metallic: - -- :ref:`float` **metallic** - -+-----------+---------------------+ -| *Default* | ``0.0`` | -+-----------+---------------------+ -| *Setter* | set_metallic(value) | -+-----------+---------------------+ -| *Getter* | get_metallic() | -+-----------+---------------------+ - -The reflectivity of the object's surface. The higher the value, the more light is reflected. - ----- - -.. _class_SpatialMaterial_property_metallic_specular: - -- :ref:`float` **metallic_specular** - -+-----------+---------------------+ -| *Default* | ``0.5`` | -+-----------+---------------------+ -| *Setter* | set_specular(value) | -+-----------+---------------------+ -| *Getter* | 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`. - ----- - -.. _class_SpatialMaterial_property_metallic_texture: - -- :ref:`Texture` **metallic_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to specify metallic for an object. This is multiplied by :ref:`metallic`. - ----- - -.. _class_SpatialMaterial_property_metallic_texture_channel: - -- :ref:`TextureChannel` **metallic_texture_channel** - -+-----------+-------------------------------------+ -| *Default* | ``0`` | -+-----------+-------------------------------------+ -| *Setter* | set_metallic_texture_channel(value) | -+-----------+-------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_normal_enabled: - -- :ref:`bool` **normal_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, normal mapping is enabled. - ----- - -.. _class_SpatialMaterial_property_normal_scale: - -- :ref:`float` **normal_scale** - -+----------+-------------------------+ -| *Setter* | set_normal_scale(value) | -+----------+-------------------------+ -| *Getter* | get_normal_scale() | -+----------+-------------------------+ - -The strength of the normal map's effect. - ----- - -.. _class_SpatialMaterial_property_normal_texture: - -- :ref:`Texture` **normal_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to specify the normal at a given pixel. The ``normal_texture`` only uses the red and green channels. The normal read from ``normal_texture`` is oriented around the surface normal provided by the :ref:`Mesh`. - ----- - -.. _class_SpatialMaterial_property_params_alpha_scissor_threshold: - -- :ref:`float` **params_alpha_scissor_threshold** - -+----------+------------------------------------+ -| *Setter* | set_alpha_scissor_threshold(value) | -+----------+------------------------------------+ -| *Getter* | get_alpha_scissor_threshold() | -+----------+------------------------------------+ - -Threshold at which the alpha scissor will discard values. - ----- - -.. _class_SpatialMaterial_property_params_billboard_keep_scale: - -- :ref:`bool` **params_billboard_keep_scale** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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`. - ----- - -.. _class_SpatialMaterial_property_params_billboard_mode: - -- :ref:`BillboardMode` **params_billboard_mode** - -+-----------+---------------------------+ -| *Default* | ``0`` | -+-----------+---------------------------+ -| *Setter* | set_billboard_mode(value) | -+-----------+---------------------------+ -| *Getter* | get_billboard_mode() | -+-----------+---------------------------+ - -Controls how the object faces the camera. See :ref:`BillboardMode`. - ----- - -.. _class_SpatialMaterial_property_params_blend_mode: - -- :ref:`BlendMode` **params_blend_mode** - -+-----------+-----------------------+ -| *Default* | ``0`` | -+-----------+-----------------------+ -| *Setter* | set_blend_mode(value) | -+-----------+-----------------------+ -| *Getter* | get_blend_mode() | -+-----------+-----------------------+ - -The material's blend mode. - -**Note:** Values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode`. - ----- - -.. _class_SpatialMaterial_property_params_cull_mode: - -- :ref:`CullMode` **params_cull_mode** - -+-----------+----------------------+ -| *Default* | ``0`` | -+-----------+----------------------+ -| *Setter* | set_cull_mode(value) | -+-----------+----------------------+ -| *Getter* | get_cull_mode() | -+-----------+----------------------+ - -Which side of the object is not drawn when backfaces are rendered. See :ref:`CullMode`. - ----- - -.. _class_SpatialMaterial_property_params_depth_draw_mode: - -- :ref:`DepthDrawMode` **params_depth_draw_mode** - -+-----------+----------------------------+ -| *Default* | ``0`` | -+-----------+----------------------------+ -| *Setter* | set_depth_draw_mode(value) | -+-----------+----------------------------+ -| *Getter* | get_depth_draw_mode() | -+-----------+----------------------------+ - -Determines when depth rendering takes place. See :ref:`DepthDrawMode`. See also :ref:`flags_transparent`. - ----- - -.. _class_SpatialMaterial_property_params_diffuse_mode: - -- :ref:`DiffuseMode` **params_diffuse_mode** - -+-----------+-------------------------+ -| *Default* | ``0`` | -+-----------+-------------------------+ -| *Setter* | set_diffuse_mode(value) | -+-----------+-------------------------+ -| *Getter* | get_diffuse_mode() | -+-----------+-------------------------+ - -The algorithm used for diffuse light scattering. See :ref:`DiffuseMode`. - ----- - -.. _class_SpatialMaterial_property_params_grow: - -- :ref:`bool` **params_grow** - -+-----------+-------------------------+ -| *Default* | ``false`` | -+-----------+-------------------------+ -| *Setter* | set_grow_enabled(value) | -+-----------+-------------------------+ -| *Getter* | is_grow_enabled() | -+-----------+-------------------------+ - -If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. - ----- - -.. _class_SpatialMaterial_property_params_grow_amount: - -- :ref:`float` **params_grow_amount** - -+----------+-----------------+ -| *Setter* | set_grow(value) | -+----------+-----------------+ -| *Getter* | get_grow() | -+----------+-----------------+ - -Grows object vertices in the direction of their normals. - ----- - -.. _class_SpatialMaterial_property_params_line_width: - -- :ref:`float` **params_line_width** - -+-----------+-----------------------+ -| *Default* | ``1.0`` | -+-----------+-----------------------+ -| *Setter* | set_line_width(value) | -+-----------+-----------------------+ -| *Getter* | get_line_width() | -+-----------+-----------------------+ - -Currently unimplemented in Godot. - ----- - -.. _class_SpatialMaterial_property_params_point_size: - -- :ref:`float` **params_point_size** - -+-----------+-----------------------+ -| *Default* | ``1.0`` | -+-----------+-----------------------+ -| *Setter* | set_point_size(value) | -+-----------+-----------------------+ -| *Getter* | get_point_size() | -+-----------+-----------------------+ - -The point size in pixels. See :ref:`flags_use_point_size`. - ----- - -.. _class_SpatialMaterial_property_params_specular_mode: - -- :ref:`SpecularMode` **params_specular_mode** - -+-----------+--------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------+ -| *Setter* | set_specular_mode(value) | -+-----------+--------------------------+ -| *Getter* | get_specular_mode() | -+-----------+--------------------------+ - -The method for rendering the specular blob. See :ref:`SpecularMode`. - ----- - -.. _class_SpatialMaterial_property_params_use_alpha_scissor: - -- :ref:`bool` **params_use_alpha_scissor** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the shader will discard all pixels that have an alpha value less than :ref:`params_alpha_scissor_threshold`. - ----- - -.. _class_SpatialMaterial_property_particles_anim_h_frames: - -- :ref:`int` **particles_anim_h_frames** - -+----------+------------------------------------+ -| *Setter* | set_particles_anim_h_frames(value) | -+----------+------------------------------------+ -| *Getter* | 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`. - ----- - -.. _class_SpatialMaterial_property_particles_anim_loop: - -- :ref:`bool` **particles_anim_loop** - -+----------+--------------------------------+ -| *Setter* | set_particles_anim_loop(value) | -+----------+--------------------------------+ -| *Getter* | get_particles_anim_loop() | -+----------+--------------------------------+ - -If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES`. See :ref:`params_billboard_mode`. - ----- - -.. _class_SpatialMaterial_property_particles_anim_v_frames: - -- :ref:`int` **particles_anim_v_frames** - -+----------+------------------------------------+ -| *Setter* | set_particles_anim_v_frames(value) | -+----------+------------------------------------+ -| *Getter* | 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`. - ----- - -.. _class_SpatialMaterial_property_proximity_fade_distance: - -- :ref:`float` **proximity_fade_distance** - -+----------+------------------------------------+ -| *Setter* | set_proximity_fade_distance(value) | -+----------+------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_proximity_fade_enable: - -- :ref:`bool` **proximity_fade_enable** - -+-----------+-----------------------------+ -| *Default* | ``false`` | -+-----------+-----------------------------+ -| *Setter* | set_proximity_fade(value) | -+-----------+-----------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_refraction_enabled: - -- :ref:`bool` **refraction_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. - ----- - -.. _class_SpatialMaterial_property_refraction_scale: - -- :ref:`float` **refraction_scale** - -+----------+-----------------------+ -| *Setter* | set_refraction(value) | -+----------+-----------------------+ -| *Getter* | get_refraction() | -+----------+-----------------------+ - -The strength of the refraction effect. - ----- - -.. _class_SpatialMaterial_property_refraction_texture: - -- :ref:`Texture` **refraction_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale`. - ----- - -.. _class_SpatialMaterial_property_refraction_texture_channel: - -- :ref:`TextureChannel` **refraction_texture_channel** - -+----------+---------------------------------------+ -| *Setter* | set_refraction_texture_channel(value) | -+----------+---------------------------------------+ -| *Getter* | get_refraction_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. - ----- - -.. _class_SpatialMaterial_property_rim: - -- :ref:`float` **rim** - -+----------+----------------+ -| *Setter* | set_rim(value) | -+----------+----------------+ -| *Getter* | get_rim() | -+----------+----------------+ - -Sets the strength of the rim lighting effect. - ----- - -.. _class_SpatialMaterial_property_rim_enabled: - -- :ref:`bool` **rim_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. - ----- - -.. _class_SpatialMaterial_property_rim_texture: - -- :ref:`Texture` **rim_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim`. - ----- - -.. _class_SpatialMaterial_property_rim_tint: - -- :ref:`float` **rim_tint** - -+----------+---------------------+ -| *Setter* | set_rim_tint(value) | -+----------+---------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_roughness: - -- :ref:`float` **roughness** - -+-----------+----------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------+ -| *Setter* | set_roughness(value) | -+-----------+----------------------+ -| *Getter* | 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`. - ----- - -.. _class_SpatialMaterial_property_roughness_texture: - -- :ref:`Texture` **roughness_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness`. - ----- - -.. _class_SpatialMaterial_property_roughness_texture_channel: - -- :ref:`TextureChannel` **roughness_texture_channel** - -+-----------+--------------------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------------------+ -| *Setter* | set_roughness_texture_channel(value) | -+-----------+--------------------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_enabled: - -- :ref:`bool` **subsurf_scatter_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_strength: - -- :ref:`float` **subsurf_scatter_strength** - -+----------+-------------------------------------------+ -| *Setter* | set_subsurface_scattering_strength(value) | -+----------+-------------------------------------------+ -| *Getter* | get_subsurface_scattering_strength() | -+----------+-------------------------------------------+ - -The strength of the subsurface scattering effect. - ----- - -.. _class_SpatialMaterial_property_subsurf_scatter_texture: - -- :ref:`Texture` **subsurf_scatter_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength`. - ----- - -.. _class_SpatialMaterial_property_transmission: - -- :ref:`Color` **transmission** - -+----------+-------------------------+ -| *Setter* | set_transmission(value) | -+----------+-------------------------+ -| *Getter* | get_transmission() | -+----------+-------------------------+ - -The color used by the transmission effect. Represents the light passing through an object. - ----- - -.. _class_SpatialMaterial_property_transmission_enabled: - -- :ref:`bool` **transmission_enabled** - -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_feature(value) | -+-----------+--------------------+ -| *Getter* | get_feature() | -+-----------+--------------------+ - -If ``true``, the transmission effect is enabled. - ----- - -.. _class_SpatialMaterial_property_transmission_texture: - -- :ref:`Texture` **transmission_texture** - -+----------+--------------------+ -| *Setter* | set_texture(value) | -+----------+--------------------+ -| *Getter* | get_texture() | -+----------+--------------------+ - -Texture used to control the transmission effect per-pixel. Added to :ref:`transmission`. - ----- - -.. _class_SpatialMaterial_property_uv1_offset: - -- :ref:`Vector3` **uv1_offset** - -+-----------+------------------------+ -| *Default* | ``Vector3( 0, 0, 0 )`` | -+-----------+------------------------+ -| *Setter* | set_uv1_offset(value) | -+-----------+------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_uv1_scale: - -- :ref:`Vector3` **uv1_scale** - -+-----------+------------------------+ -| *Default* | ``Vector3( 1, 1, 1 )`` | -+-----------+------------------------+ -| *Setter* | set_uv1_scale(value) | -+-----------+------------------------+ -| *Getter* | get_uv1_scale() | -+-----------+------------------------+ - -How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. - ----- - -.. _class_SpatialMaterial_property_uv1_triplanar: - -- :ref:`bool` **uv1_triplanar** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_uv1_triplanar_sharpness: - -- :ref:`float` **uv1_triplanar_sharpness** - -+-----------+------------------------------------------+ -| *Default* | ``1.0`` | -+-----------+------------------------------------------+ -| *Setter* | set_uv1_triplanar_blend_sharpness(value) | -+-----------+------------------------------------------+ -| *Getter* | get_uv1_triplanar_blend_sharpness() | -+-----------+------------------------------------------+ - -A lower number blends the texture more softly while a higher number blends the texture more sharply. - ----- - -.. _class_SpatialMaterial_property_uv2_offset: - -- :ref:`Vector3` **uv2_offset** - -+-----------+------------------------+ -| *Default* | ``Vector3( 0, 0, 0 )`` | -+-----------+------------------------+ -| *Setter* | set_uv2_offset(value) | -+-----------+------------------------+ -| *Getter* | 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. - ----- - -.. _class_SpatialMaterial_property_uv2_scale: - -- :ref:`Vector3` **uv2_scale** - -+-----------+------------------------+ -| *Default* | ``Vector3( 1, 1, 1 )`` | -+-----------+------------------------+ -| *Setter* | set_uv2_scale(value) | -+-----------+------------------------+ -| *Getter* | get_uv2_scale() | -+-----------+------------------------+ - -How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. - ----- - -.. _class_SpatialMaterial_property_uv2_triplanar: - -- :ref:`bool` **uv2_triplanar** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -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. - ----- - -.. _class_SpatialMaterial_property_uv2_triplanar_sharpness: - -- :ref:`float` **uv2_triplanar_sharpness** - -+-----------+------------------------------------------+ -| *Default* | ``1.0`` | -+-----------+------------------------------------------+ -| *Setter* | set_uv2_triplanar_blend_sharpness(value) | -+-----------+------------------------------------------+ -| *Getter* | get_uv2_triplanar_blend_sharpness() | -+-----------+------------------------------------------+ - -A lower number blends the texture more softly while a higher number blends the texture more sharply. - ----- - -.. _class_SpatialMaterial_property_vertex_color_is_srgb: - -- :ref:`bool` **vertex_color_is_srgb** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the model's vertex colors are processed as sRGB mode. - ----- - -.. _class_SpatialMaterial_property_vertex_color_use_as_albedo: - -- :ref:`bool` **vertex_color_use_as_albedo** - -+-----------+-----------------+ -| *Default* | ``false`` | -+-----------+-----------------+ -| *Setter* | set_flag(value) | -+-----------+-----------------+ -| *Getter* | get_flag() | -+-----------+-----------------+ - -If ``true``, the vertex color is used as albedo color. - -Method Descriptions -------------------- - -.. _class_SpatialMaterial_method_get_feature: - -- :ref:`bool` **get_feature** **(** :ref:`Feature` feature **)** const - -Returns ``true``, if the specified :ref:`Feature` is enabled. - ----- - -.. _class_SpatialMaterial_method_get_flag: - -- :ref:`bool` **get_flag** **(** :ref:`Flags` flag **)** const - -Returns ``true``, if the specified flag is enabled. See :ref:`Flags` enumerator for options. - ----- - -.. _class_SpatialMaterial_method_get_texture: - -- :ref:`Texture` **get_texture** **(** :ref:`TextureParam` param **)** const - -Returns the :ref:`Texture` associated with the specified :ref:`TextureParam`. - ----- - -.. _class_SpatialMaterial_method_set_feature: - -- 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``. - ----- - -.. _class_SpatialMaterial_method_set_flag: - -- void **set_flag** **(** :ref:`Flags` flag, :ref:`bool` enable **)** - -If ``true``, enables the specified flag. Flags are optional behaviour 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. - ----- - -.. _class_SpatialMaterial_method_set_texture: - -- 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``. - diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index c6d6fa55c..9b1879a96 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -57,9 +57,9 @@ Methods Theme Properties ---------------- -+-------------------------------+--------+ -| :ref:`Texture` | updown | -+-------------------------------+--------+ ++-----------------------------------+--------+ +| :ref:`Texture2D` | updown | ++-----------------------------------+--------+ Property Descriptions --------------------- diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index e1059b8f1..75e01bb9a 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -128,7 +128,7 @@ Method Descriptions - void **add_excluded_object** **(** :ref:`RID` RID **)** -Adds the object with the given :ref:`RID` to the list of objects excluded from the collision check. +Adds the :ref:`PhysicsBody` object with the given :ref:`RID` to the list of :ref:`PhysicsBody` objects excluded from the collision check. ---- @@ -136,7 +136,7 @@ Adds the object with the given :ref:`RID` to the list of objects excl - void **clear_excluded_objects** **(** **)** -Clears the list of objects excluded from the collision check. +Clears the list of :ref:`PhysicsBody` objects excluded from the collision check. ---- @@ -152,5 +152,5 @@ Returns the proportion between the current arm length (after checking for collis - :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** -Removes the given :ref:`RID` from the list of objects excluded from the collision check. +Removes the given :ref:`RID` from the list of :ref:`PhysicsBody` objects excluded from the collision check. diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index bd8b29a79..b3e6301ca 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -21,33 +21,39 @@ A node that displays a 2D texture. The texture displayed can be a region from a Properties ---------- -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`centered` | ``true`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`flip_h` | ``false`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`flip_v` | ``false`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`frame` | ``0`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`Vector2` | :ref:`frame_coords` | ``Vector2( 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`hframes` | ``1`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`normal_map` | | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`region_enabled` | ``false`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`region_filter_clip` | ``false`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`vframes` | ``1`` | -+-------------------------------+---------------------------------------------------------------------+-------------------------+ ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`centered` | ``true`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`flip_h` | ``false`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`flip_v` | ``false`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`frame` | ``0`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`frame_coords` | ``Vector2( 0, 0 )`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`hframes` | ``1`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`normal_map` | | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`region_enabled` | ``false`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`region_filter_clip` | ``false`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`shininess` | ``1.0`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`specular_color` | ``Color( 1, 1, 1, 1 )`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`specular_map` | | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`texture` | | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`vframes` | ``1`` | ++-----------------------------------+---------------------------------------------------------------------+-------------------------+ Methods ------- @@ -176,7 +182,7 @@ The number of columns in the sprite sheet. .. _class_Sprite_property_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture2D` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | @@ -252,9 +258,55 @@ The region of the atlas texture to display. :ref:`region_enabled` **shininess** + ++-----------+----------------------+ +| *Default* | ``1.0`` | ++-----------+----------------------+ +| *Setter* | set_shininess(value) | ++-----------+----------------------+ +| *Getter* | get_shininess() | ++-----------+----------------------+ + +Strength of the specular light effect of this ``Sprite``. + +---- + +.. _class_Sprite_property_specular_color: + +- :ref:`Color` **specular_color** + ++-----------+---------------------------+ +| *Default* | ``Color( 1, 1, 1, 1 )`` | ++-----------+---------------------------+ +| *Setter* | set_specular_color(value) | ++-----------+---------------------------+ +| *Getter* | get_specular_color() | ++-----------+---------------------------+ + +The color of the specular light effect. + +---- + +.. _class_Sprite_property_specular_map: + +- :ref:`Texture2D` **specular_map** + ++----------+-------------------------+ +| *Setter* | set_specular_map(value) | ++----------+-------------------------+ +| *Getter* | get_specular_map() | ++----------+-------------------------+ + +The specular map is used for more control on the shininess effect. + +---- + .. _class_Sprite_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -262,7 +314,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. +:ref:`Texture2D` object to draw. ---- diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 00e4c000e..7a99f801d 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -18,24 +18,26 @@ Description A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. +**Note:** There are `known performance issues `_ when using ``Sprite3D``. Consider using a :ref:`MeshInstance` with a :ref:`QuadMesh` as the mesh instead. You can still have billboarding by enabling billboard properties in the QuadMesh's :ref:`StandardMaterial3D`. + Properties ---------- -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`frame` | ``0`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`Vector2` | :ref:`frame_coords` | ``Vector2( 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`hframes` | ``1`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`region_enabled` | ``false`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | -+-------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`int` | :ref:`vframes` | ``1`` | -+-------------------------------+---------------------------------------------------------------+-------------------------+ ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`frame` | ``0`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`frame_coords` | ``Vector2( 0, 0 )`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`hframes` | ``1`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`region_enabled` | ``false`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Texture2D` | :ref:`texture` | | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`int` | :ref:`vframes` | ``1`` | ++-----------------------------------+---------------------------------------------------------------+-------------------------+ Signals ------- @@ -131,7 +133,7 @@ The region of the atlas texture to display. :ref:`region_enabled` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -139,7 +141,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. +:ref:`Texture2D` object to draw. ---- diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index cd0a0251d..9620be051 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -23,33 +23,33 @@ A node that displays 2D texture information in a 3D environment. Properties ---------- -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :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:`flip_h` | ``false`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`bool` | :ref:`flip_v` | ``false`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`opacity` | ``1.0`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :ref:`float` | :ref:`pixel_size` | ``0.01`` | -+----------------------------------------------------------+---------------------------------------------------------------+-------------------------+ -| :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:`flip_h` | ``false`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`flip_v` | ``false`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Color` | :ref:`modulate` | ``Color( 1, 1, 1, 1 )`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`opacity` | ``1.0`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`float` | :ref:`pixel_size` | ``0.01`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`shaded` | ``false`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`transparent` | ``true`` | ++---------------------------------------------------------+---------------------------------------------------------------+-------------------------+ Methods ------- @@ -140,7 +140,7 @@ The direction in which the front of the texture faces. .. _class_SpriteBase3D_property_billboard: -- :ref:`BillboardMode` **billboard** +- :ref:`BillboardMode` **billboard** +-----------+---------------------------+ | *Default* | ``0`` | @@ -323,15 +323,21 @@ Method Descriptions - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** const +Returns the value of the specified flag. + ---- .. _class_SpriteBase3D_method_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const +Returns the rectangle representing this sprite. + ---- .. _class_SpriteBase3D_method_set_draw_flag: - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** +If ``true``, the specified flag will be enabled. + diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 91ff646a2..e4a1e49f1 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -28,39 +28,39 @@ Properties Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`StringName` anim **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`StringName` anim, :ref:`Texture2D` frame, :ref:`int` at_position=-1 **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`StringName` anim **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`StringName` anim **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_animation_names` **(** **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`StringName` anim **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_frame` **(** :ref:`StringName` anim, :ref:`int` idx **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`StringName` anim **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`StringName` anim **)** const | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`StringName` anim **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`StringName` anim, :ref:`int` idx **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`StringName` anim, :ref:`StringName` newname **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`StringName` anim, :ref:`bool` loop **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`StringName` anim, :ref:`float` speed **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`StringName` anim, :ref:`int` idx, :ref:`Texture2D` txt **)** | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -76,7 +76,7 @@ Method Descriptions .. _class_SpriteFrames_method_add_animation: -- void **add_animation** **(** :ref:`String` anim **)** +- void **add_animation** **(** :ref:`StringName` anim **)** Adds a new animation to the library. @@ -84,7 +84,7 @@ Adds a new animation to the library. .. _class_SpriteFrames_method_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** +- void **add_frame** **(** :ref:`StringName` anim, :ref:`Texture2D` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. @@ -92,7 +92,7 @@ Adds a frame to the given animation. .. _class_SpriteFrames_method_clear: -- void **clear** **(** :ref:`String` anim **)** +- void **clear** **(** :ref:`StringName` anim **)** Removes all frames from the given animation. @@ -108,7 +108,7 @@ Removes all animations. A "default" animation will be created. .. _class_SpriteFrames_method_get_animation_loop: -- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const +- :ref:`bool` **get_animation_loop** **(** :ref:`StringName` anim **)** const If ``true``, the given animation will loop. @@ -116,7 +116,7 @@ If ``true``, the given animation will loop. .. _class_SpriteFrames_method_get_animation_names: -- :ref:`PoolStringArray` **get_animation_names** **(** **)** const +- :ref:`PackedStringArray` **get_animation_names** **(** **)** const Returns an array containing the names associated to each animation. Values are placed in alphabetical order. @@ -124,7 +124,7 @@ Returns an array containing the names associated to each animation. Values are p .. _class_SpriteFrames_method_get_animation_speed: -- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const +- :ref:`float` **get_animation_speed** **(** :ref:`StringName` anim **)** const The animation's speed in frames per second. @@ -132,7 +132,7 @@ The animation's speed in frames per second. .. _class_SpriteFrames_method_get_frame: -- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const +- :ref:`Texture2D` **get_frame** **(** :ref:`StringName` anim, :ref:`int` idx **)** const Returns the animation's selected frame. @@ -140,7 +140,7 @@ Returns the animation's selected frame. .. _class_SpriteFrames_method_get_frame_count: -- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const +- :ref:`int` **get_frame_count** **(** :ref:`StringName` anim **)** const Returns the number of frames in the animation. @@ -148,7 +148,7 @@ Returns the number of frames in the animation. .. _class_SpriteFrames_method_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const +- :ref:`bool` **has_animation** **(** :ref:`StringName` anim **)** const If ``true``, the named animation exists. @@ -156,7 +156,7 @@ If ``true``, the named animation exists. .. _class_SpriteFrames_method_remove_animation: -- void **remove_animation** **(** :ref:`String` anim **)** +- void **remove_animation** **(** :ref:`StringName` anim **)** Removes the given animation. @@ -164,7 +164,7 @@ Removes the given animation. .. _class_SpriteFrames_method_remove_frame: -- void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** +- void **remove_frame** **(** :ref:`StringName` anim, :ref:`int` idx **)** Removes the animation's selected frame. @@ -172,7 +172,7 @@ Removes the animation's selected frame. .. _class_SpriteFrames_method_rename_animation: -- void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`StringName` anim, :ref:`StringName` newname **)** Changes the animation's name to ``newname``. @@ -180,7 +180,7 @@ Changes the animation's name to ``newname``. .. _class_SpriteFrames_method_set_animation_loop: -- void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** +- void **set_animation_loop** **(** :ref:`StringName` anim, :ref:`bool` loop **)** If ``true``, the animation will loop. @@ -188,7 +188,7 @@ If ``true``, the animation will loop. .. _class_SpriteFrames_method_set_animation_speed: -- void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** +- void **set_animation_speed** **(** :ref:`StringName` anim, :ref:`float` speed **)** The animation's speed in frames per second. @@ -196,7 +196,7 @@ The animation's speed in frames per second. .. _class_SpriteFrames_method_set_frame: -- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** +- void **set_frame** **(** :ref:`StringName` anim, :ref:`int` idx, :ref:`Texture2D` txt **)** Sets the texture of the given frame. diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst new file mode 100644 index 000000000..d60e35f35 --- /dev/null +++ b/classes/class_standardmaterial3d.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the StandardMaterial3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_StandardMaterial3D: + +StandardMaterial3D +================== + +**Inherits:** :ref:`BaseMaterial3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + + + diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index acbab955d..277a573ce 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -23,37 +23,17 @@ Additionally, a constant linear or angular velocity can be set for the static bo Properties ---------- -+-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`bounce` | | +-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`constant_angular_velocity` | ``Vector3( 0, 0, 0 )`` | +-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector3` | :ref:`constant_linear_velocity` | ``Vector3( 0, 0, 0 )`` | +-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ -| :ref:`float` | :ref:`friction` | | -+-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ | :ref:`PhysicsMaterial` | :ref:`physics_material_override` | | +-----------------------------------------------+---------------------------------------------------------------------------------------+------------------------+ Property Descriptions --------------------- -.. _class_StaticBody_property_bounce: - -- :ref:`float` **bounce** - -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ - -The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). - -Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. - ----- - .. _class_StaticBody_property_constant_angular_velocity: - :ref:`Vector3` **constant_angular_velocity** @@ -86,22 +66,6 @@ The body's constant linear velocity. This does not move the body, but affects ot ---- -.. _class_StaticBody_property_friction: - -- :ref:`float` **friction** - -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ - -The body's friction, from 0 (frictionless) to 1 (full friction). - -Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. - ----- - .. _class_StaticBody_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 7e52b7472..72ec8c60e 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -23,37 +23,17 @@ Additionally, a constant linear or angular velocity can be set for the static bo Properties ---------- -+-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`bounce` | | +-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`constant_angular_velocity` | ``0.0`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`constant_linear_velocity` | ``Vector2( 0, 0 )`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ -| :ref:`float` | :ref:`friction` | | -+-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ | :ref:`PhysicsMaterial` | :ref:`physics_material_override` | | +-----------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ Property Descriptions --------------------- -.. _class_StaticBody2D_property_bounce: - -- :ref:`float` **bounce** - -+----------+-------------------+ -| *Setter* | set_bounce(value) | -+----------+-------------------+ -| *Getter* | get_bounce() | -+----------+-------------------+ - -The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). - -Deprecated, use :ref:`PhysicsMaterial.bounce` instead via :ref:`physics_material_override`. - ----- - .. _class_StaticBody2D_property_constant_angular_velocity: - :ref:`float` **constant_angular_velocity** @@ -86,22 +66,6 @@ The body's constant linear velocity. This does not move the body, but affects co ---- -.. _class_StaticBody2D_property_friction: - -- :ref:`float` **friction** - -+----------+---------------------+ -| *Setter* | set_friction(value) | -+----------+---------------------+ -| *Getter* | get_friction() | -+----------+---------------------+ - -The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). - -Deprecated, use :ref:`PhysicsMaterial.friction` instead via :ref:`physics_material_override`. - ----- - .. _class_StaticBody2D_property_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 6c88be169..087a34d5d 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -71,13 +71,13 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_8` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | +| :ref:`Error` | :ref:`put_data` **(** :ref:`PackedByteArray` data **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_double` **(** :ref:`float` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_float` **(** :ref:`float` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PackedByteArray` data **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_string` **(** :ref:`String` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -278,7 +278,7 @@ Puts a signed byte into the stream. .. _class_StreamPeer_method_put_data: -- :ref:`Error` **put_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`Error` **put_data** **(** :ref:`PackedByteArray` data **)** Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an :ref:`Error` code. @@ -302,7 +302,7 @@ Puts a single-precision float into the stream. .. _class_StreamPeer_method_put_partial_data: -- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`Array` **put_partial_data** **(** :ref:`PackedByteArray` data **)** Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an :ref:`Error` code and an integer, describing how much data was actually sent. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 53db89987..99dc0963a 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -16,9 +16,9 @@ StreamPeerBuffer Properties ---------- -+-------------------------------------------+---------------------------------------------------------------+-----------------------+ -| :ref:`PoolByteArray` | :ref:`data_array` | ``PoolByteArray( )`` | -+-------------------------------------------+---------------------------------------------------------------+-----------------------+ ++-----------------------------------------------+---------------------------------------------------------------+-------------------------+ +| :ref:`PackedByteArray` | :ref:`data_array` | ``PackedByteArray( )`` | ++-----------------------------------------------+---------------------------------------------------------------+-------------------------+ Methods ------- @@ -42,15 +42,15 @@ Property Descriptions .. _class_StreamPeerBuffer_property_data_array: -- :ref:`PoolByteArray` **data_array** +- :ref:`PackedByteArray` **data_array** -+-----------+-----------------------+ -| *Default* | ``PoolByteArray( )`` | -+-----------+-----------------------+ -| *Setter* | set_data_array(value) | -+-----------+-----------------------+ -| *Getter* | get_data_array() | -+-----------+-----------------------+ ++-----------+-------------------------+ +| *Default* | ``PackedByteArray( )`` | ++-----------+-------------------------+ +| *Setter* | set_data_array(value) | ++-----------+-------------------------+ +| *Getter* | get_data_array() | ++-----------+-------------------------+ Method Descriptions ------------------- diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 35d1bf4c3..889eda0f2 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -64,11 +64,11 @@ enum **Status**: - **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected. -- **STATUS_HANDSHAKING** = **1** +- **STATUS_HANDSHAKING** = **1** --- A status representing a ``StreamPeerSSL`` during handshaking. - **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerSSL`` that is connected to a host. -- **STATUS_ERROR** = **3** +- **STATUS_ERROR** = **3** --- A status representing a ``StreamPeerSSL`` in error state. - **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 9ada9b262..e31f91fdb 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -9,7 +9,7 @@ StreamTexture ============= -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` A ``.stex`` texture. @@ -21,11 +21,9 @@ A texture that is loaded from a ``.stex`` file. Properties ---------- -+-----------------------------+----------------------------------------------------------+--------------+ -| :ref:`int` | flags | **O:** ``0`` | -+-----------------------------+----------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`load_path` | ``""`` | -+-----------------------------+----------------------------------------------------------+--------------+ ++-----------------------------+----------------------------------------------------------+--------+ +| :ref:`String` | :ref:`load_path` | ``""`` | ++-----------------------------+----------------------------------------------------------+--------+ Methods ------- @@ -58,3 +56,5 @@ Method Descriptions - :ref:`Error` **load** **(** :ref:`String` path **)** +Loads the texture from the given path. + diff --git a/classes/class_string.rst b/classes/class_string.rst index 08b57a47e..be33a273a 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -24,215 +24,231 @@ Tutorials Methods ------- -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_escape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_unescape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capitalize` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`countn` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`dedent` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_dir` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basename` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_extension` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hex_to_int` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`http_escape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`http_unescape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`humanize_size` **(** :ref:`int` size **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_abs_path` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_rel_path` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_filename` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_float` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=False **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`json_escape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`length` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`md5_text` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_decode` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_encode` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`rsplit` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`sha1_buffer` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha1_text` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha256_text` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_escapes` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`to_float` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_int` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_lower` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_upper` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_escape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_unescape` **(** **)** | -+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector2i` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Rect2i` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Vector3i` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`StringName` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Callable` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Signal` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedByteArray` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedInt32Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedInt64Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedFloat32Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedFloat64Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedStringArray` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedVector2Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedVector3Array` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`String` **(** :ref:`PackedColorArray` from **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`bigrams` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_escape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`c_unescape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capitalize` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`countn` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`dedent` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_base_dir` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_basename` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_extension` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_file` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hex_to_int` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`http_escape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`http_unescape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`humanize_size` **(** :ref:`int` size **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_abs_path` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_rel_path` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_filename` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_float` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=false **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_integer` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`json_escape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`length` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`md5_buffer` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`md5_text` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_decode` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_encode` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`rsplit` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`sha1_buffer` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha1_text` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`sha256_buffer` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha256_text` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`split` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`split_floats` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=true, :ref:`bool` right=true **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_escapes` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_ascii` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`to_float` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_int` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_lower` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`to_upper` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`to_utf8` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_escape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xml_unescape` **(** **)** | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -263,18 +279,36 @@ Constructs a new String from the given :ref:`Vector2`. ---- +- :ref:`String` **String** **(** :ref:`Vector2i` from **)** + +Constructs a new String from the given :ref:`Vector2i`. + +---- + - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. ---- +- :ref:`String` **String** **(** :ref:`Rect2i` from **)** + +Constructs a new String from the given :ref:`Rect2i`. + +---- + - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. ---- +- :ref:`String` **String** **(** :ref:`Vector3i` from **)** + +Constructs a new String from the given :ref:`Vector3i`. + +---- + - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. @@ -317,6 +351,12 @@ Constructs a new String from the given :ref:`Color`. ---- +- :ref:`String` **String** **(** :ref:`StringName` from **)** + +Constructs a new String from the given :ref:`StringName`. + +---- + - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. @@ -329,6 +369,18 @@ Constructs a new String from the given :ref:`RID`. ---- +- :ref:`String` **String** **(** :ref:`Callable` from **)** + +Constructs a new String from the given :ref:`Callable`. + +---- + +- :ref:`String` **String** **(** :ref:`Signal` from **)** + +Constructs a new String from the given :ref:`Signal`. + +---- + - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. @@ -341,45 +393,57 @@ Constructs a new String from the given :ref:`Array`. ---- -- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** +- :ref:`String` **String** **(** :ref:`PackedByteArray` from **)** -Constructs a new String from the given :ref:`PoolByteArray`. +Constructs a new String from the given :ref:`PackedByteArray`. ---- -- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** +- :ref:`String` **String** **(** :ref:`PackedInt32Array` from **)** -Constructs a new String from the given :ref:`PoolIntArray`. +Constructs a new String from the given :ref:`PackedInt32Array`. ---- -- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** +- :ref:`String` **String** **(** :ref:`PackedInt64Array` from **)** -Constructs a new String from the given :ref:`PoolRealArray`. +Constructs a new String from the given :ref:`PackedInt64Array`. ---- -- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** +- :ref:`String` **String** **(** :ref:`PackedFloat32Array` from **)** -Constructs a new String from the given :ref:`PoolStringArray`. +Constructs a new String from the given :ref:`PackedFloat32Array`. ---- -- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** +- :ref:`String` **String** **(** :ref:`PackedFloat64Array` from **)** -Constructs a new String from the given :ref:`PoolVector2Array`. +Constructs a new String from the given :ref:`PackedFloat64Array`. ---- -- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** +- :ref:`String` **String** **(** :ref:`PackedStringArray` from **)** -Constructs a new String from the given :ref:`PoolVector3Array`. +Constructs a new String from the given :ref:`PackedStringArray`. ---- -- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** +- :ref:`String` **String** **(** :ref:`PackedVector2Array` from **)** -Constructs a new String from the given :ref:`PoolColorArray`. +Constructs a new String from the given :ref:`PackedVector2Array`. + +---- + +- :ref:`String` **String** **(** :ref:`PackedVector3Array` from **)** + +Constructs a new String from the given :ref:`PackedVector3Array`. + +---- + +- :ref:`String` **String** **(** :ref:`PackedColorArray` from **)** + +Constructs a new String from the given :ref:`PackedColorArray`. ---- @@ -393,7 +457,7 @@ Returns ``true`` if the string begins with the given string. .. _class_String_method_bigrams: -- :ref:`PoolStringArray` **bigrams** **(** **)** +- :ref:`PackedStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. @@ -505,7 +569,7 @@ Finds the first occurrence of a substring, ignoring case. Returns the starting p .. _class_String_method_format: -- :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** +- :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** Formats the string by replacing all occurrences of ``placeholder`` with ``values``. @@ -661,7 +725,7 @@ Returns ``true`` if this string contains a valid float. .. _class_String_method_is_valid_hex_number: -- :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=False **)** +- :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=false **)** Returns ``true`` if this string contains a valid hexadecimal number. If ``with_prefix`` is ``true``, then a validity of the hexadecimal number is determined by ``0x`` prefix, for instance: ``0xDEADC0DE``. @@ -749,7 +813,7 @@ Does a simple case-insensitive expression match, where ``"*"`` matches zero or m .. _class_String_method_md5_buffer: -- :ref:`PoolByteArray` **md5_buffer** **(** **)** +- :ref:`PackedByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. @@ -869,7 +933,7 @@ Returns the right side of the string from a given position. .. _class_String_method_rsplit: -- :ref:`PoolStringArray` **rsplit** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** +- :ref:`PackedStringArray` **rsplit** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** Splits the string by a ``delimiter`` string and returns an array of the substrings, starting from right. @@ -899,7 +963,7 @@ Returns a copy of the string with characters removed from the right. .. _class_String_method_sha1_buffer: -- :ref:`PoolByteArray` **sha1_buffer** **(** **)** +- :ref:`PackedByteArray` **sha1_buffer** **(** **)** Returns the SHA-1 hash of the string as an array of bytes. @@ -915,7 +979,7 @@ Returns the SHA-1 hash of the string as a string. .. _class_String_method_sha256_buffer: -- :ref:`PoolByteArray` **sha256_buffer** **(** **)** +- :ref:`PackedByteArray` **sha256_buffer** **(** **)** Returns the SHA-256 hash of the string as an array of bytes. @@ -939,7 +1003,7 @@ Returns the similarity index of the text compared to this string. 1 means totall .. _class_String_method_split: -- :ref:`PoolStringArray` **split** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** +- :ref:`PackedStringArray` **split** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** Splits the string by a ``delimiter`` string and returns an array of the substrings. @@ -959,7 +1023,7 @@ Example: .. _class_String_method_split_floats: -- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=True **)** +- :ref:`PackedFloat32Array` **split_floats** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** Splits the string in floats by using a delimiter string and returns an array of the substrings. @@ -969,7 +1033,7 @@ For example, ``"1,2.5,3"`` will return ``[1,2.5,3]`` if split by ``","``. .. _class_String_method_strip_edges: -- :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** +- :ref:`String` **strip_edges** **(** :ref:`bool` left=true, :ref:`bool` right=true **)** Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. @@ -993,9 +1057,9 @@ Returns part of the string from the position ``from`` with length ``len``. Argum .. _class_String_method_to_ascii: -- :ref:`PoolByteArray` **to_ascii** **(** **)** +- :ref:`PackedByteArray` **to_ascii** **(** **)** -Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is faster compared to :ref:`to_utf8`, as this method assumes that all the characters in the String are ASCII characters. +Converts the String (which is a character array) to :ref:`PackedByteArray` (which is an array of bytes). The conversion is faster compared to :ref:`to_utf8`, as this method assumes that all the characters in the String are ASCII characters. ---- @@ -1033,9 +1097,9 @@ Returns the string converted to uppercase. .. _class_String_method_to_utf8: -- :ref:`PoolByteArray` **to_utf8** **(** **)** +- :ref:`PackedByteArray` **to_utf8** **(** **)** -Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii`. +Converts the String (which is an array of characters) to :ref:`PackedByteArray` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii`. ---- diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst new file mode 100644 index 000000000..719b0a2c9 --- /dev/null +++ b/classes/class_stringname.rst @@ -0,0 +1,34 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the StringName.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_StringName: + +StringName +========== + +An optimized string type for unique names. + +Description +----------- + +``StringName``\ s are immutable strings designed for general-purpose represention of unique names. ``StringName`` ensures that only one instance of a given name exists (so two ``StringName``\ s with the same value are the same object). Comparing them is much faster than with regular :ref:`String`\ s, because only the pointers are compared, not the whole strings. + +Methods +------- + ++-------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`StringName` **(** :ref:`String` from **)** | ++-------------------------------------+----------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_StringName_method_StringName: + +- :ref:`StringName` **StringName** **(** :ref:`String` from **)** + +Creates a new ``StringName`` from the given :ref:`String`. + diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index c4886e129..b5d97bd04 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -46,11 +46,11 @@ Properties +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`modulate_color` | ``Color( 1, 1, 1, 1 )`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`normal_map` | | +| :ref:`Texture2D` | :ref:`normal_map` | | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +--------------------------------------------------------------+----------------------------------------------------------------------------------------+-------------------------+ Methods @@ -311,7 +311,7 @@ Modulates the color of the texture when this style box is drawn. .. _class_StyleBoxTexture_property_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture2D` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | @@ -343,7 +343,7 @@ This is equivalent to first wrapping the texture in an :ref:`AtlasTexture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 59413fadb..2e85cf9b0 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -35,60 +35,60 @@ Additionally, the attributes used before the first vertex is added determine the Methods ------- -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertices, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`commit_to_arrays` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_blend_shape` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_tangents` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PackedInt32Array` bones **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PackedVector3Array` vertices, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`PackedColorArray` colors=PackedColorArray( ), :ref:`PackedVector2Array` uv2s=PackedVector2Array( ), :ref:`PackedVector3Array` normals=PackedVector3Array( ), :ref:`Array` tangents=[ ] **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PackedFloat32Array` weights **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=31744 **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`commit_to_arrays` **(** **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_blend_shape` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`String` blend_shape **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** :ref:`bool` flip=false **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_tangents` **(** **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_SurfaceTool_method_add_bones: -- void **add_bones** **(** :ref:`PoolIntArray` bones **)** +- void **add_bones** **(** :ref:`PackedInt32Array` bones **)** Adds an array of bones for the next vertex to use. ``bones`` must contain 4 integers. @@ -136,7 +136,7 @@ Specifies a tangent for the next vertex to use. .. _class_SurfaceTool_method_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertices, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** +- void **add_triangle_fan** **(** :ref:`PackedVector3Array` vertices, :ref:`PackedVector2Array` uvs=PackedVector2Array( ), :ref:`PackedColorArray` colors=PackedColorArray( ), :ref:`PackedVector2Array` uv2s=PackedVector2Array( ), :ref:`PackedVector3Array` normals=PackedVector3Array( ), :ref:`Array` tangents=[ ] **)** Inserts a triangle fan made of array data into :ref:`Mesh` being constructed. @@ -170,7 +170,7 @@ Specifies the position of current vertex. Should be called after specifying othe .. _class_SurfaceTool_method_add_weights: -- void **add_weights** **(** :ref:`PoolRealArray` weights **)** +- void **add_weights** **(** :ref:`PackedFloat32Array` weights **)** Specifies weight values for next vertex to use. ``weights`` must contain 4 values. @@ -202,7 +202,7 @@ Clear all information passed into the surface tool so far. .. _class_SurfaceTool_method_commit: -- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=31744 **)** Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index f611a244d..2296db892 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -42,78 +42,72 @@ Properties Methods ------- -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :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` idx **)** const | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :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_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` idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_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_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | decrement | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | decrement_highlight | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_bg | Color( 0.69, 0.69, 0.69, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_fg | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | increment | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | increment_highlight | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | label_valign_bg | 2 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | label_valign_fg | 0 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | menu | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | menu_highlight | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | panel | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | side_margin | 8 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_bg | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_disabled | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_fg | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | top_margin | 24 | -+---------------------------------+---------------------+------------------------------+ ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | decrement | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | decrement_highlight | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_bg | Color( 0.69, 0.69, 0.69, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_fg | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | increment | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | increment_highlight | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | menu | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | menu_highlight | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | panel | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`int` | side_margin | 8 | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_bg | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_disabled | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_fg | | ++-----------------------------------+---------------------+------------------------------+ Signals ------- @@ -293,9 +287,9 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_TabContainer_method_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** const -Returns the :ref:`Texture` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture`. +Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture2D`. ---- @@ -335,7 +329,7 @@ If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. .. _class_TabContainer_method_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** Sets an icon for the tab at index ``tab_idx``. diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 09af531ab..ce59790ea 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -36,86 +36,80 @@ Properties Methods ------- -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_count` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | -+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_offset_buttons_visible` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_select_with_rmb` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_count` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_offset` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_select_with_rmb` **(** :ref:`bool` enabled **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | button | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | button_pressed | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | close | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | decrement | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | decrement_highlight | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_bg | Color( 0.69, 0.69, 0.69, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Color` | font_color_fg | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | increment | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`Texture` | increment_highlight | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | label_valign_bg | 2 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | label_valign_fg | 0 | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | panel | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_bg | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_disabled | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`StyleBox` | tab_fg | | -+---------------------------------+---------------------+------------------------------+ -| :ref:`int` | top_margin | 24 | -+---------------------------------+---------------------+------------------------------+ ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | button | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | button_pressed | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | close | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | decrement | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | decrement_highlight | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_bg | Color( 0.69, 0.69, 0.69, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Color` | font_color_fg | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | increment | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`Texture2D` | increment_highlight | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | panel | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_bg | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_disabled | | ++-----------------------------------+---------------------+------------------------------+ +| :ref:`StyleBox` | tab_fg | | ++-----------------------------------+---------------------+------------------------------+ Signals ------- @@ -297,7 +291,7 @@ Method Descriptions .. _class_Tabs_method_add_tab: -- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** +- void **add_tab** **(** :ref:`String` title="", :ref:`Texture2D` icon=null **)** Adds a new tab. @@ -345,9 +339,9 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_Tabs_method_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture2D` **get_tab_icon** **(** :ref:`int` tab_idx **)** const -Returns the :ref:`Texture` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture`. +Returns the :ref:`Texture2D` for the tab at index ``tab_idx`` or ``null`` if the tab has no :ref:`Texture2D`. ---- @@ -419,7 +413,7 @@ If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. .. _class_Tabs_method_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture2D` icon **)** Sets an ``icon`` for the tab at index ``tab_idx``. diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 99181a9f0..de0484e06 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -82,176 +82,176 @@ Properties Methods ------- -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_viewport_to_cursor` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_colors` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_undo_history` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cut` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fold_all_lines` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fold_line` **(** :ref:`int` line **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_line_count` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_line_hidden` **(** :ref:`int` line **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`menu_option` **(** :ref:`int` option **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`paste` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`redo` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_breakpoints` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_all` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_line_as_hidden` **(** :ref:`int` line, :ref:`bool` enable **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`toggle_fold_line` **(** :ref:`int` line **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`undo` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unfold_line` **(** :ref:`int` line **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhide_all_lines` **(** **)** | -+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_viewport_to_cursor` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_colors` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_undo_history` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_column` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`cursor_get_line` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cut` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_all_lines` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fold_line` **(** :ref:`int` line **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_line_hidden` **(** :ref:`int` line **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_active` **(** **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`menu_option` **(** :ref:`int` option **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`paste` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_breakpoints` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select_all` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_line_as_hidden` **(** :ref:`int` line, :ref:`bool` enable **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_fold_line` **(** :ref:`int` line **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unfold_line` **(** :ref:`int` line **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unhide_all_lines` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | background_color | Color( 0, 0, 0, 0 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | bookmark_color | Color( 0.08, 0.49, 0.98, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | brace_mismatch_color | Color( 1, 0.2, 0.2, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | breakpoint_color | Color( 0.8, 0.8, 0.4, 0.2 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | caret_background_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | caret_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | code_folding_color | Color( 0.8, 0.8, 0.8, 0.8 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`StyleBox` | completion | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | completion_background_color | Color( 0.17, 0.16, 0.2, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | completion_existing_color | Color( 0.87, 0.87, 0.87, 0.13 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | completion_font_color | Color( 0.67, 0.67, 0.67, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`int` | completion_lines | 7 | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`int` | completion_max_width | 50 | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | completion_scroll_color | Color( 1, 1, 1, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`int` | completion_scroll_width | 3 | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | completion_selected_color | Color( 0.26, 0.26, 0.27, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | current_line_color | Color( 0.25, 0.25, 0.26, 0.8 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | executing_line_color | Color( 0.2, 0.8, 0.2, 0.4 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`StyleBox` | focus | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Texture` | fold | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Texture` | folded | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | font_color_readonly | Color( 0.88, 0.88, 0.88, 0.5 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | function_color | Color( 0.4, 0.64, 0.81, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | line_number_color | Color( 0.67, 0.67, 0.67, 0.4 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`int` | line_spacing | 4 | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | mark_color | Color( 1, 0.4, 0.4, 0.4 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | member_variable_color | Color( 0.9, 0.31, 0.35, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`StyleBox` | normal | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | number_color | Color( 0.92, 0.58, 0.2, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`StyleBox` | read_only | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | safe_line_number_color | Color( 0.67, 0.78, 0.67, 0.6 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Texture` | space | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | symbol_color | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Texture` | tab | | -+---------------------------------+-----------------------------+---------------------------------+ -| :ref:`Color` | word_highlighted_color | Color( 0.8, 0.9, 0.9, 0.15 ) | -+---------------------------------+-----------------------------+---------------------------------+ ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | background_color | Color( 0, 0, 0, 0 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | bookmark_color | Color( 0.08, 0.49, 0.98, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | brace_mismatch_color | Color( 1, 0.2, 0.2, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | breakpoint_color | Color( 0.8, 0.8, 0.4, 0.2 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | caret_background_color | Color( 0, 0, 0, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | caret_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | code_folding_color | Color( 0.8, 0.8, 0.8, 0.8 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`StyleBox` | completion | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | completion_background_color | Color( 0.17, 0.16, 0.2, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | completion_existing_color | Color( 0.87, 0.87, 0.87, 0.13 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | completion_font_color | Color( 0.67, 0.67, 0.67, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`int` | completion_lines | 7 | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`int` | completion_max_width | 50 | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | completion_scroll_color | Color( 1, 1, 1, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`int` | completion_scroll_width | 3 | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | completion_selected_color | Color( 0.26, 0.26, 0.27, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | current_line_color | Color( 0.25, 0.25, 0.26, 0.8 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | executing_line_color | Color( 0.2, 0.8, 0.2, 0.4 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`StyleBox` | focus | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Texture2D` | fold | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Texture2D` | folded | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | font_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | font_color_readonly | Color( 0.88, 0.88, 0.88, 0.5 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | font_color_selected | Color( 0, 0, 0, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | function_color | Color( 0.4, 0.64, 0.81, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | line_number_color | Color( 0.67, 0.67, 0.67, 0.4 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`int` | line_spacing | 4 | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | mark_color | Color( 1, 0.4, 0.4, 0.4 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | member_variable_color | Color( 0.9, 0.31, 0.35, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`StyleBox` | normal | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | number_color | Color( 0.92, 0.58, 0.2, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`StyleBox` | read_only | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | safe_line_number_color | Color( 0.67, 0.78, 0.67, 0.6 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Texture2D` | space | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | symbol_color | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Texture2D` | tab | | ++-----------------------------------+-----------------------------+---------------------------------+ +| :ref:`Color` | word_highlighted_color | Color( 0.8, 0.9, 0.9, 0.15 ) | ++-----------------------------------+-----------------------------+---------------------------------+ Signals ------- @@ -292,6 +292,12 @@ Emitted when the info icon is clicked. ---- +.. _class_TextEdit_signal_symbol_validate: + +- **symbol_validate** **(** :ref:`String` symbol **)** + +---- + .. _class_TextEdit_signal_text_changed: - **text_changed** **(** **)** @@ -1069,11 +1075,11 @@ Removes all the breakpoints. This will not fire the :ref:`breakpoint_toggled` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const +- :ref:`PackedInt32Array` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags` enum. -Returns an empty ``PoolIntArray`` if no result was found. Otherwise, the result line and column can be accessed at indices specified in the :ref:`SearchResult` enum, e.g: +Returns an empty ``PackedInt32Array`` if no result was found. Otherwise, the result line and column can be accessed at indices specified in the :ref:`SearchResult` enum, e.g: :: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 11f1b078c..b08533736 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -11,167 +11,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CurveTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`LargeTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture`, :ref:`ViewportTexture` +**Inherited By:** :ref:`Texture2D`, :ref:`TextureLayered` -Texture for 2D and 3D. -Description ------------ - -A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. - -Textures are often created by loading them from a file. See :ref:`@GDScript.load`. - -``Texture`` is a base for other resources. It cannot be used directly. - -Properties ----------- - -+-----------------------+--------------------------------------------+-------+ -| :ref:`int` | :ref:`flags` | ``4`` | -+-----------------------+--------------------------------------------+-------+ - -Methods -------- - -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_Texture_Flags: - -.. _class_Texture_constant_FLAGS_DEFAULT: - -.. _class_Texture_constant_FLAG_MIPMAPS: - -.. _class_Texture_constant_FLAG_REPEAT: - -.. _class_Texture_constant_FLAG_FILTER: - -.. _class_Texture_constant_FLAG_ANISOTROPIC_FILTER: - -.. _class_Texture_constant_FLAG_CONVERT_TO_LINEAR: - -.. _class_Texture_constant_FLAG_MIRRORED_REPEAT: - -.. _class_Texture_constant_FLAG_VIDEO_SURFACE: - -enum **Flags**: - -- **FLAGS_DEFAULT** = **7** --- Default flags. :ref:`FLAG_MIPMAPS`, :ref:`FLAG_REPEAT` and :ref:`FLAG_FILTER` are enabled. - -- **FLAG_MIPMAPS** = **1** --- Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. - -- **FLAG_REPEAT** = **2** --- Repeats the texture (instead of clamp to edge). - -- **FLAG_FILTER** = **4** --- Uses a magnifying filter, to enable smooth zooming in of the texture. - -- **FLAG_ANISOTROPIC_FILTER** = **8** --- Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. - -This results in better-looking textures when viewed from oblique angles. - -- **FLAG_CONVERT_TO_LINEAR** = **16** --- Converts the texture to the sRGB color space. - -- **FLAG_MIRRORED_REPEAT** = **32** --- Repeats the texture with alternate sections mirrored. - -- **FLAG_VIDEO_SURFACE** = **2048** --- Texture is a video surface. - -Property Descriptions ---------------------- - -.. _class_Texture_property_flags: - -- :ref:`int` **flags** - -+-----------+------------------+ -| *Default* | ``4`` | -+-----------+------------------+ -| *Setter* | set_flags(value) | -+-----------+------------------+ -| *Getter* | get_flags() | -+-----------+------------------+ - -The texture's :ref:`Flags`. :ref:`Flags` are used to set various properties of the ``Texture``. - -Method Descriptions -------------------- - -.. _class_Texture_method_draw: - -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const - -Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API at the specified ``position``. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect` with a rect at ``position`` and the size of this ``Texture``. - ----- - -.. _class_Texture_method_draw_rect: - -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const - -Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect`. - ----- - -.. _class_Texture_method_draw_rect_region: - -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const - -Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. Equivalent to :ref:`VisualServer.canvas_item_add_texture_rect_region`. - ----- - -.. _class_Texture_method_get_data: - -- :ref:`Image` **get_data** **(** **)** const - -Returns an :ref:`Image` with the data from this ``Texture``. :ref:`Image`\ s can be accessed and manipulated directly. - ----- - -.. _class_Texture_method_get_height: - -- :ref:`int` **get_height** **(** **)** const - -Returns the texture height. - ----- - -.. _class_Texture_method_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -Returns the texture size. - ----- - -.. _class_Texture_method_get_width: - -- :ref:`int` **get_width** **(** **)** const - -Returns the texture width. - ----- - -.. _class_Texture_method_has_alpha: - -- :ref:`bool` **has_alpha** **(** **)** const - -Returns ``true`` if this ``Texture`` has an alpha channel. diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst new file mode 100644 index 000000000..10aaea47a --- /dev/null +++ b/classes/class_texture2d.rst @@ -0,0 +1,112 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Texture2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Texture2D: + +Texture2D +========= + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CameraTexture`, :ref:`CurveTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`LargeTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture`, :ref:`ViewportTexture` + +Texture for 2D and 3D. + +Description +----------- + +A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. + +Textures are often created by loading them from a file. See :ref:`@GDScript.load`. + +``Texture2D`` is a base for other resources. It cannot be used directly. + +Methods +------- + ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0 **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0 **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0, :ref:`bool` clip_uv=true **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_data` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** const | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_Texture2D_method_draw: + +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0 **)** const + +Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API at the specified ``position``. + +---- + +.. _class_Texture2D_method_draw_rect: + +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0 **)** const + +Draws the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. + +---- + +.. _class_Texture2D_method_draw_rect_region: + +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture2D` normal_map=null, :ref:`Texture2D` specular_map=null, :ref:`Color` specular_color_shininess=Color( 1, 1, 1, 1 ), :ref:`CanvasItemTextureFilter` texture_filter=0, :ref:`CanvasItemTextureRepeat` texture_repeat=0, :ref:`bool` clip_uv=true **)** const + +Draws a part of the texture using a :ref:`CanvasItem` with the :ref:`VisualServer` API. + +---- + +.. _class_Texture2D_method_get_data: + +- :ref:`Image` **get_data** **(** **)** const + +Returns an :ref:`Image` with the data from this ``Texture2D``. :ref:`Image`\ s can be accessed and manipulated directly. + +---- + +.. _class_Texture2D_method_get_height: + +- :ref:`int` **get_height** **(** **)** const + +Returns the texture height. + +---- + +.. _class_Texture2D_method_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + +Returns the texture size. + +---- + +.. _class_Texture2D_method_get_width: + +- :ref:`int` **get_width** **(** **)** const + +Returns the texture width. + +---- + +.. _class_Texture2D_method_has_alpha: + +- :ref:`bool` **has_alpha** **(** **)** const + +Returns ``true`` if this ``Texture2D`` has an alpha channel. + diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst new file mode 100644 index 000000000..a8bde3953 --- /dev/null +++ b/classes/class_texture2darray.rst @@ -0,0 +1,15 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Texture2DArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Texture2DArray: + +Texture2DArray +============== + +**Inherits:** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + + + diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst deleted file mode 100644 index 2ec137d66..000000000 --- a/classes/class_texture3d.rst +++ /dev/null @@ -1,27 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the Texture3D.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_Texture3D: - -Texture3D -========= - -**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -Texture with 3 dimensions. - -Description ------------ - -Texture3D is a 3-dimensional texture that has a width, height, and depth. - -Properties ----------- - -+-------------------------------------+------+---------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | data | **O:** ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}`` | -+-------------------------------------+------+---------------------------------------------------------------------------------------+ - diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst deleted file mode 100644 index e10a51b2e..000000000 --- a/classes/class_texturearray.rst +++ /dev/null @@ -1,20 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the TextureArray.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_TextureArray: - -TextureArray -============ - -**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -Array of textures stored in a single primitive. - -Description ------------ - -``TextureArray``\ s store an array of images in a single :ref:`Texture` primitive. Each layer of the texture array has its own mipmap chain. This makes it is a good alternative to texture atlases. - diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index f3bd06b3a..8905cd8df 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -30,15 +30,15 @@ Properties +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`BitMap` | :ref:`texture_click_mask` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`texture_disabled` | | +| :ref:`Texture2D` | :ref:`texture_disabled` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`texture_focused` | | +| :ref:`Texture2D` | :ref:`texture_focused` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`texture_hover` | | +| :ref:`Texture2D` | :ref:`texture_hover` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`texture_normal` | | +| :ref:`Texture2D` | :ref:`texture_normal` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`texture_pressed` | | +| :ref:`Texture2D` | :ref:`texture_pressed` | | +----------------------------------------------------+----------------------------------------------------------------------------+-----------+ Enumerations @@ -127,7 +127,7 @@ Pure black and white :ref:`BitMap` image to use for click detectio .. _class_TextureButton_property_texture_disabled: -- :ref:`Texture` **texture_disabled** +- :ref:`Texture2D` **texture_disabled** +----------+-----------------------------+ | *Setter* | set_disabled_texture(value) | @@ -141,7 +141,7 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_focused** +- :ref:`Texture2D` **texture_focused** +----------+----------------------------+ | *Setter* | set_focused_texture(value) | @@ -155,7 +155,7 @@ Texture to display when the node has mouse or keyboard focus. .. _class_TextureButton_property_texture_hover: -- :ref:`Texture` **texture_hover** +- :ref:`Texture2D` **texture_hover** +----------+--------------------------+ | *Setter* | set_hover_texture(value) | @@ -169,7 +169,7 @@ Texture to display when the mouse hovers the node. .. _class_TextureButton_property_texture_normal: -- :ref:`Texture` **texture_normal** +- :ref:`Texture2D` **texture_normal** +----------+---------------------------+ | *Setter* | set_normal_texture(value) | @@ -183,7 +183,7 @@ Texture to display by default, when the node is **not** in the disabled, focused .. _class_TextureButton_property_texture_pressed: -- :ref:`Texture` **texture_pressed** +- :ref:`Texture2D` **texture_pressed** +----------+----------------------------+ | *Setter* | set_pressed_texture(value) | diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 76bfa854f..e9e3f913b 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -9,107 +9,42 @@ TextureLayered ============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Texture3D`, :ref:`TextureArray` +**Inherited By:** :ref:`Cubemap`, :ref:`CubemapArray`, :ref:`Texture2DArray` Base class for 3D texture types. Description ----------- -Base class for :ref:`Texture3D` and :ref:`TextureArray`. Cannot be used directly. - -Properties ----------- - -+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`data` | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}`` | -+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`flags` | ``4`` | -+-------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------+ +Base class for :ref:`Texture2DArray`, :ref:`Cubemap` and :ref:`CubemapArray`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. Data is set on a per-layer basis. For :ref:`Texture2DArray`\ s, the layer specifies the array layer. Methods ------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_depth` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data_partial` **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Enumerations ------------- - -.. _enum_TextureLayered_Flags: - -.. _class_TextureLayered_constant_FLAG_MIPMAPS: - -.. _class_TextureLayered_constant_FLAG_REPEAT: - -.. _class_TextureLayered_constant_FLAG_FILTER: - -.. _class_TextureLayered_constant_FLAGS_DEFAULT: - -enum **Flags**: - -- **FLAG_MIPMAPS** = **1** - -- **FLAG_REPEAT** = **2** - -- **FLAG_FILTER** = **4** - -- **FLAGS_DEFAULT** = **4** - -Property Descriptions ---------------------- - -.. _class_TextureLayered_property_data: - -- :ref:`Dictionary` **data** - -+-----------+--------------------------------------------------------------------------------+ -| *Default* | ``{"depth": 0,"flags": 4,"format": 37,"height": 0,"layers": [ ],"width": 0}`` | -+-----------+--------------------------------------------------------------------------------+ - ----- - -.. _class_TextureLayered_property_flags: - -- :ref:`int` **flags** - -+-----------+------------------+ -| *Default* | ``4`` | -+-----------+------------------+ -| *Setter* | set_flags(value) | -+-----------+------------------+ -| *Getter* | get_flags() | -+-----------+------------------+ ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_from_images` **(** :ref:`Array` images **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Format` | :ref:`get_format` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_layers` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_layer` **(** :ref:`Image` image, :ref:`int` layer **)** | ++---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_TextureLayered_method_create: +.. _class_TextureLayered_method_create_from_images: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** - ----- - -.. _class_TextureLayered_method_get_depth: - -- :ref:`int` **get_depth** **(** **)** const +- :ref:`Error` **create_from_images** **(** :ref:`Array` images **)** ---- @@ -117,33 +52,41 @@ Method Descriptions - :ref:`Format` **get_format** **(** **)** const +Returns the current format being used by this texture. See :ref:`Format` for details. + ---- .. _class_TextureLayered_method_get_height: - :ref:`int` **get_height** **(** **)** const +Returns the height of the texture. Height is typically represented by the Y-axis. + ---- .. _class_TextureLayered_method_get_layer_data: - :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const +Returns an :ref:`Image` resource with the data from specified ``layer``. + +---- + +.. _class_TextureLayered_method_get_layers: + +- :ref:`int` **get_layers** **(** **)** const + ---- .. _class_TextureLayered_method_get_width: - :ref:`int` **get_width** **(** **)** const ----- - -.. _class_TextureLayered_method_set_data_partial: - -- void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** +Returns the width of the texture. Width is typically represented by the X-axis. ---- -.. _class_TextureLayered_method_set_layer_data: +.. _class_TextureLayered_method_update_layer: -- void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** +- void **update_layer** **(** :ref:`Image` image, :ref:`int` layer **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 9b7248d1e..3d29b8779 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -42,11 +42,11 @@ Properties +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`stretch_margin_top` | ``0`` | +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture_over` | | +| :ref:`Texture2D` | :ref:`texture_over` | | +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture_progress` | | +| :ref:`Texture2D` | :ref:`texture_progress` | | +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ -| :ref:`Texture` | :ref:`texture_under` | | +| :ref:`Texture2D` | :ref:`texture_under` | | +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`tint_over` | ``Color( 1, 1, 1, 1 )`` | +----------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ @@ -258,7 +258,7 @@ The height of the 9-patch's top row. .. _class_TextureProgress_property_texture_over: -- :ref:`Texture` **texture_over** +- :ref:`Texture2D` **texture_over** +----------+-------------------------+ | *Setter* | set_over_texture(value) | @@ -266,13 +266,13 @@ The height of the 9-patch's top row. | *Getter* | get_over_texture() | +----------+-------------------------+ -:ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. +:ref:`Texture2D` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. ---- .. _class_TextureProgress_property_texture_progress: -- :ref:`Texture` **texture_progress** +- :ref:`Texture2D` **texture_progress** +----------+-----------------------------+ | *Setter* | set_progress_texture(value) | @@ -280,7 +280,7 @@ The height of the 9-patch's top row. | *Getter* | get_progress_texture() | +----------+-----------------------------+ -:ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. +:ref:`Texture2D` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. @@ -288,7 +288,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val .. _class_TextureProgress_property_texture_under: -- :ref:`Texture` **texture_under** +- :ref:`Texture2D` **texture_under** +----------+--------------------------+ | *Setter* | set_under_texture(value) | @@ -296,7 +296,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val | *Getter* | get_under_texture() | +----------+--------------------------+ -:ref:`Texture` that draws under the progress bar. The bar's background. +:ref:`Texture2D` that draws under the progress bar. The bar's background. ---- diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index ccc144c9c..f668b0ccf 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -32,7 +32,7 @@ Properties +--------------------------------------------------+--------------------------------------------------------------+--------------+ | :ref:`StretchMode` | :ref:`stretch_mode` | ``0`` | +--------------------------------------------------+--------------------------------------------------------------+--------------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +--------------------------------------------------+--------------------------------------------------------------+--------------+ Enumerations @@ -143,7 +143,7 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See .. _class_TextureRect_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -151,5 +151,5 @@ Controls the texture's behavior when resizing the node's bounding rectangle. See | *Getter* | get_texture() | +----------+--------------------+ -The node's :ref:`Texture` resource. +The node's :ref:`Texture2D` resource. diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 486837c87..80e99f39b 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -35,67 +35,67 @@ Properties Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_default_theme` **(** **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_theme` **(** :ref:`Theme` other **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_color` **(** :ref:`StringName` name, :ref:`StringName` type **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_constant` **(** :ref:`StringName` name, :ref:`StringName` type **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_font` **(** :ref:`StringName` name, :ref:`StringName` type **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_icon` **(** :ref:`StringName` name, :ref:`StringName` type **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_default_theme` **(** **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_theme` **(** :ref:`Theme` other **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Font` | :ref:`get_font` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_icon` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_stylebox_types` **(** **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_color` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_constant` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_font` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_icon` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type **)** const | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Color` color **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant` **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`int` constant **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_font` **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Font` font **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Texture2D` texture **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stylebox` **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`StyleBox` texture **)** | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -125,7 +125,7 @@ Clears all values on the theme. .. _class_Theme_method_clear_color: -- void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_color** **(** :ref:`StringName` name, :ref:`StringName` type **)** Clears the :ref:`Color` at ``name`` if the theme has ``type``. @@ -133,7 +133,7 @@ Clears the :ref:`Color` at ``name`` if the theme has ``type``. .. _class_Theme_method_clear_constant: -- void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_constant** **(** :ref:`StringName` name, :ref:`StringName` type **)** Clears the constant at ``name`` if the theme has ``type``. @@ -141,7 +141,7 @@ Clears the constant at ``name`` if the theme has ``type``. .. _class_Theme_method_clear_font: -- void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_font** **(** :ref:`StringName` name, :ref:`StringName` type **)** Clears the :ref:`Font` at ``name`` if the theme has ``type``. @@ -149,7 +149,7 @@ Clears the :ref:`Font` at ``name`` if the theme has ``type``. .. _class_Theme_method_clear_icon: -- void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_icon** **(** :ref:`StringName` name, :ref:`StringName` type **)** Clears the icon at ``name`` if the theme has ``type``. @@ -157,7 +157,7 @@ Clears the icon at ``name`` if the theme has ``type``. .. _class_Theme_method_clear_stylebox: -- void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type **)** Clears :ref:`StyleBox` at ``name`` if the theme has ``type``. @@ -181,7 +181,7 @@ Sets the theme's values to a copy of a given theme. .. _class_Theme_method_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Color` **get_color** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns the :ref:`Color` at ``name`` if the theme has ``type``. @@ -189,15 +189,15 @@ Returns the :ref:`Color` at ``name`` if the theme has ``type``. .. _class_Theme_method_get_color_list: -- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_color_list** **(** :ref:`String` type **)** const -Returns all the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if the theme has ``type``. +Returns all the :ref:`Color`\ s as a :ref:`PackedStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if the theme has ``type``. ---- .. _class_Theme_method_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`int` **get_constant** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns the constant at ``name`` if the theme has ``type``. @@ -205,15 +205,15 @@ Returns the constant at ``name`` if the theme has ``type``. .. _class_Theme_method_get_constant_list: -- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_constant_list** **(** :ref:`String` type **)** const -Returns all the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if the theme has ``type``. +Returns all the constants as a :ref:`PackedStringArray` filled with each constant's name, for use in :ref:`get_constant`, if the theme has ``type``. ---- .. _class_Theme_method_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Font` **get_font** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns the :ref:`Font` at ``name`` if the theme has ``type``. @@ -221,31 +221,31 @@ Returns the :ref:`Font` at ``name`` if the theme has ``type``. .. _class_Theme_method_get_font_list: -- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_font_list** **(** :ref:`String` type **)** const -Returns all the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if the theme has ``type``. +Returns all the :ref:`Font`\ s as a :ref:`PackedStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if the theme has ``type``. ---- .. _class_Theme_method_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Texture2D` **get_icon** **(** :ref:`StringName` name, :ref:`StringName` type **)** const -Returns the icon :ref:`Texture` at ``name`` if the theme has ``type``. +Returns the icon :ref:`Texture2D` at ``name`` if the theme has ``type``. ---- .. _class_Theme_method_get_icon_list: -- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_icon_list** **(** :ref:`String` type **)** const -Returns all the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if the theme has ``type``. +Returns all the icons as a :ref:`PackedStringArray` filled with each :ref:`Texture2D`'s name, for use in :ref:`get_icon`, if the theme has ``type``. ---- .. _class_Theme_method_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns the icon :ref:`StyleBox` at ``name`` if the theme has ``type``. @@ -253,31 +253,31 @@ Returns the icon :ref:`StyleBox` at ``name`` if the theme has `` .. _class_Theme_method_get_stylebox_list: -- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const -Returns all the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if the theme has ``type``. +Returns all the :ref:`StyleBox`\ s as a :ref:`PackedStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if the theme has ``type``. ---- .. _class_Theme_method_get_stylebox_types: -- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const +- :ref:`PackedStringArray` **get_stylebox_types** **(** **)** const -Returns all the :ref:`StyleBox` types as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if the theme has ``type``. +Returns all the :ref:`StyleBox` types as a :ref:`PackedStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if the theme has ``type``. ---- .. _class_Theme_method_get_type_list: -- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const +- :ref:`PackedStringArray` **get_type_list** **(** :ref:`String` type **)** const -Returns all the types in ``type`` as a :ref:`PoolStringArray` for use in any of the ``get_*`` functions, if the theme has ``type``. +Returns all the types in ``type`` as a :ref:`PackedStringArray` for use in any of the ``get_*`` functions, if the theme has ``type``. ---- .. _class_Theme_method_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_color** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. @@ -287,7 +287,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_constant** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns ``true`` if constant with ``name`` is in ``type``. @@ -297,7 +297,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_font** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. @@ -307,9 +307,9 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_icon** **(** :ref:`StringName` name, :ref:`StringName` type **)** const -Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``type``. +Returns ``true`` if icon :ref:`Texture2D` with ``name`` is in ``type``. Returns ``false`` if the theme does not have ``type``. @@ -317,7 +317,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type **)** const Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type``. @@ -327,7 +327,7 @@ Returns ``false`` if the theme does not have ``type``. .. _class_Theme_method_set_color: -- void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** +- void **set_color** **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Color` color **)** Sets the theme's :ref:`Color` to ``color`` at ``name`` in ``type``. @@ -337,7 +337,7 @@ Does nothing if the theme does not have ``type``. .. _class_Theme_method_set_constant: -- void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** +- void **set_constant** **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`int` constant **)** Sets the theme's constant to ``constant`` at ``name`` in ``type``. @@ -347,7 +347,7 @@ Does nothing if the theme does not have ``type``. .. _class_Theme_method_set_font: -- void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** +- void **set_font** **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Font` font **)** Sets the theme's :ref:`Font` to ``font`` at ``name`` in ``type``. @@ -357,9 +357,9 @@ Does nothing if the theme does not have ``type``. .. _class_Theme_method_set_icon: -- void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`Texture2D` texture **)** -Sets the theme's icon :ref:`Texture` to ``texture`` at ``name`` in ``type``. +Sets the theme's icon :ref:`Texture2D` to ``texture`` at ``name`` in ``type``. Does nothing if the theme does not have ``type``. @@ -367,7 +367,7 @@ Does nothing if the theme does not have ``type``. .. _class_Theme_method_set_stylebox: -- void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** +- void **set_stylebox** **(** :ref:`StringName` name, :ref:`StringName` type, :ref:`StyleBox` texture **)** Sets theme's :ref:`StyleBox` to ``stylebox`` at ``name`` in ``type``. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index a694689a0..85cda0a48 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -26,15 +26,15 @@ Tutorials Methods ------- -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`StringName` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -76,7 +76,7 @@ Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` ca .. _class_Thread_method_start: -- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** +- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`StringName` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** Starts a new ``Thread`` that runs ``method`` on object ``instance`` with ``userdata`` passed as an argument. The ``priority`` of the ``Thread`` can be changed by passing a value from the :ref:`Priority` enum. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 4f75129d1..d0b227fcd 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -94,7 +94,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | +| :ref:`Texture2D` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -114,7 +114,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | +| :ref:`Texture2D` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -134,7 +134,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture2D` normal_map **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -152,7 +152,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture2D` texture **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -531,7 +531,7 @@ Returns the offset of the tile's navigation polygon. .. _class_TileSet_method_tile_get_normal_map: -- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const +- :ref:`Texture2D` **tile_get_normal_map** **(** :ref:`int` id **)** const Returns the tile's normal map texture. @@ -609,7 +609,7 @@ Returns an array of the tile's shapes. .. _class_TileSet_method_tile_get_texture: -- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const +- :ref:`Texture2D` **tile_get_texture** **(** :ref:`int` id **)** const Returns the tile's texture. @@ -689,7 +689,7 @@ Sets an offset for the tile's navigation polygon. .. _class_TileSet_method_tile_set_normal_map: -- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** +- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture2D` normal_map **)** Sets the tile's normal map texture. @@ -759,7 +759,7 @@ Sets an array of shapes for the tile, enabling collision. .. _class_TileSet_method_tile_set_texture: -- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture2D` texture **)** Sets the tile's texture. diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 1e5c6c5fb..447b6e115 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -26,11 +26,11 @@ Properties +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ | :ref:`BitMap` | :ref:`bitmask` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`normal` | | +| :ref:`Texture2D` | :ref:`normal` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`passby_press` | ``false`` | +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ -| :ref:`Texture` | :ref:`pressed` | | +| :ref:`Texture2D` | :ref:`pressed` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ | :ref:`Shape2D` | :ref:`shape` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+ @@ -115,7 +115,7 @@ The button's bitmask. .. _class_TouchScreenButton_property_normal: -- :ref:`Texture` **normal** +- :ref:`Texture2D` **normal** +----------+--------------------+ | *Setter* | set_texture(value) | @@ -145,7 +145,7 @@ If ``true``, pass-by presses are enabled. .. _class_TouchScreenButton_property_pressed: -- :ref:`Texture` **pressed** +- :ref:`Texture2D` **pressed** +----------+----------------------------+ | *Setter* | set_texture_pressed(value) | diff --git a/classes/class_transform.rst b/classes/class_transform.rst index cd8bd656e..309ca9a0b 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -64,9 +64,9 @@ Methods +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` offset **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | +| void | :ref:`xform` **(** :ref:`Variant` v **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +| void | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants @@ -228,15 +228,15 @@ Unlike :ref:`rotated` and :ref:`scaled` **xform** **(** :ref:`Variant` v **)** +- void **xform** **(** :ref:`Variant` v **)** -Transforms the given :ref:`Vector3`, :ref:`Plane`, :ref:`AABB`, or :ref:`PoolVector3Array` by this transform. +Transforms the given :ref:`Vector3`, :ref:`Plane`, :ref:`AABB`, or :ref:`PackedVector3Array` by this transform. ---- .. _class_Transform_method_xform_inv: -- :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** +- void **xform_inv** **(** :ref:`Variant` v **)** -Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, :ref:`AABB`, or :ref:`PoolVector3Array` by this transform. +Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, :ref:`AABB`, or :ref:`PackedVector3Array` by this transform. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index f49b39dbe..4c5d9b0ed 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -63,9 +63,9 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | +| void | :ref:`xform` **(** :ref:`Variant` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +| void | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Constants @@ -251,15 +251,15 @@ Unlike :ref:`rotated` and :ref:`scaled` **xform** **(** :ref:`Variant` v **)** +- void **xform** **(** :ref:`Variant` v **)** -Transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PoolVector2Array` by this transform. +Transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PackedVector2Array` by this transform. ---- .. _class_Transform2D_method_xform_inv: -- :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** +- void **xform_inv** **(** :ref:`Variant` v **)** -Inverse-transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PoolVector2Array` by this transform. +Inverse-transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PackedVector2Array` by this transform. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 839c98d9e..e7e1553de 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -37,17 +37,17 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_message_count` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_message` **(** :ref:`StringName` src_message, :ref:`StringName` xlated_message **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_message` **(** :ref:`StringName` src_message **)** | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_message` **(** :ref:`StringName` src_message **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_message_count` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_message_list` **(** **)** const | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -71,7 +71,7 @@ Method Descriptions .. _class_Translation_method_add_message: -- void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** +- void **add_message** **(** :ref:`StringName` src_message, :ref:`StringName` xlated_message **)** Adds a message if nonexistent, followed by its translation. @@ -79,7 +79,7 @@ Adds a message if nonexistent, followed by its translation. .. _class_Translation_method_erase_message: -- void **erase_message** **(** :ref:`String` src_message **)** +- void **erase_message** **(** :ref:`StringName` src_message **)** Erases a message. @@ -87,7 +87,7 @@ Erases a message. .. _class_Translation_method_get_message: -- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const +- :ref:`StringName` **get_message** **(** :ref:`StringName` src_message **)** const Returns a message's translation. @@ -103,7 +103,7 @@ Returns the number of existing messages. .. _class_Translation_method_get_message_list: -- :ref:`PoolStringArray` **get_message_list** **(** **)** const +- :ref:`PackedStringArray` **get_message_list** **(** **)** const Returns all the messages (keys). diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index ed61311b6..ab2da0f5d 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -28,23 +28,23 @@ Tutorials Methods ------- -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_loaded_locales` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_loaded_locales` **(** **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale` **(** **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_locale` **(** :ref:`String` locale **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`translate` **(** :ref:`StringName` message **)** const | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -107,7 +107,7 @@ Sets the locale of the game. .. _class_TranslationServer_method_translate: -- :ref:`String` **translate** **(** :ref:`String` message **)** const +- :ref:`StringName` **translate** **(** :ref:`StringName` message **)** const Returns the current locale's translation for the given message (key). diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 049ac5db5..7597a23ac 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -110,83 +110,79 @@ Methods Theme Properties ---------------- -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | arrow | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | arrow_collapsed | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | bg | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | bg_focus | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | button_margin | 4 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | button_pressed | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | checked | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | cursor | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | cursor_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | cursor_unfocused | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | custom_button_font_highlight | Color( 0.94, 0.94, 0.94, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button_hover | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | custom_button_pressed | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | draw_guides | 1 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | draw_relationship_lines | 0 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | drop_position_color | Color( 1, 0.3, 0.2, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Font` | font | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | font_color | Color( 0.69, 0.69, 0.69, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | font_color_selected | Color( 1, 1, 1, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | guide_color | Color( 0, 0, 0, 0.1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | hseparation | 4 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | item_margin | 12 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | relationship_line_color | Color( 0.27, 0.27, 0.27, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | scroll_border | 4 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | scroll_speed | 12 | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | select_arrow | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | selected | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | selected_focus | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | selection_color | Color( 0.1, 0.1, 1, 0.8 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Color` | title_button_color | Color( 0.88, 0.88, 0.88, 1 ) | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Font` | title_button_font | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_hover | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_normal | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`StyleBox` | title_button_pressed | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | unchecked | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`Texture` | updown | | -+---------------------------------+------------------------------+------------------------------+ -| :ref:`int` | vseparation | 4 | -+---------------------------------+------------------------------+------------------------------+ ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | arrow | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | arrow_collapsed | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | bg | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | bg_focus | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | button_margin | 4 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | button_pressed | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | checked | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | cursor | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | cursor_unfocused | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | custom_button_font_highlight | Color( 0.94, 0.94, 0.94, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button_hover | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | custom_button_pressed | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | draw_guides | 1 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | draw_relationship_lines | 0 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | drop_position_color | Color( 1, 0.3, 0.2, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Font` | font | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | font_color | Color( 0.69, 0.69, 0.69, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | font_color_selected | Color( 1, 1, 1, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | guide_color | Color( 0, 0, 0, 0.1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | hseparation | 4 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | item_margin | 12 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | relationship_line_color | Color( 0.27, 0.27, 0.27, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | scroll_border | 4 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | scroll_speed | 12 | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | select_arrow | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | selected | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | selected_focus | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Color` | title_button_color | Color( 0.88, 0.88, 0.88, 1 ) | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Font` | title_button_font | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_hover | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_normal | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`StyleBox` | title_button_pressed | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | unchecked | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`Texture2D` | updown | | ++-----------------------------------+------------------------------+------------------------------+ +| :ref:`int` | vseparation | 4 | ++-----------------------------------+------------------------------+------------------------------+ Signals ------- @@ -259,6 +255,8 @@ Emitted when an item is collapsed by a click on the folding arrow. - **item_custom_button_pressed** **(** **)** +Emitted when a custom button is pressed (i.e. in a :ref:`TreeItem.CELL_MODE_CUSTOM` mode cell). + ---- .. _class_Tree_signal_item_double_clicked: diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index efee7a0d1..439aed9d4 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -32,127 +32,127 @@ Properties Methods ------- -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_recursive` **(** :ref:`String` method, ... **)** vararg | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_color` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_icon_modulate` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** :ref:`bool` wrap=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** :ref:`bool` wrap=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Object` child **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`bool` disabled **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_modulate` **(** :ref:`int` column, :ref:`Color` modulate **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture2D` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call_recursive` **(** :ref:`StringName` method, ... **)** vararg | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_color` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_icon_modulate` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** :ref:`bool` wrap=false **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** :ref:`bool` wrap=false **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture2D` button **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`bool` disabled **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`StringName` callback **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture2D` texture **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_modulate` **(** :ref:`int` column, :ref:`Color` modulate **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -247,15 +247,17 @@ Method Descriptions .. _class_TreeItem_method_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture2D` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** -Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. +Adds a button with :ref:`Texture2D` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip + +``. ---- .. _class_TreeItem_method_call_recursive: -- :ref:`Variant` **call_recursive** **(** :ref:`String` method, ... **)** vararg +- :ref:`Variant` **call_recursive** **(** :ref:`StringName` method, ... **)** vararg Calls the ``method`` on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. @@ -295,9 +297,9 @@ Removes the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_method_get_button: -- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`Texture2D` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const -Returns the :ref:`Texture` of the button at index ``button_idx`` in column ``column``. +Returns the :ref:`Texture2D` of the button at index ``button_idx`` in column ``column``. ---- @@ -359,9 +361,9 @@ Returns ``true`` if ``expand_right`` is set. .. _class_TreeItem_method_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const +- :ref:`Texture2D` **get_icon** **(** :ref:`int` column **)** const -Returns the given column's icon :ref:`Texture`. Error if no icon is set. +Returns the given column's icon :ref:`Texture2D`. Error if no icon is set. ---- @@ -385,7 +387,7 @@ Returns the :ref:`Color` modulating the column's icon. - :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const -Returns the icon :ref:`Texture` region as :ref:`Rect2`. +Returns the icon :ref:`Texture2D` region as :ref:`Rect2`. ---- @@ -555,9 +557,9 @@ Selects the column ``column``. .. _class_TreeItem_method_set_button: -- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** +- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture2D` button **)** -Sets the given column's button :ref:`Texture` at index ``button_idx`` to ``button``. +Sets the given column's button :ref:`Texture2D` at index ``button_idx`` to ``button``. ---- @@ -609,7 +611,7 @@ Sets the given column's custom color. .. _class_TreeItem_method_set_custom_draw: -- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** +- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`StringName` callback **)** Sets the given column's custom draw callback to ``callback`` method on ``object``. @@ -635,9 +637,9 @@ If ``true``, column ``column`` is expanded to the right. .. _class_TreeItem_method_set_icon: -- void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`int` column, :ref:`Texture2D` texture **)** -Sets the given column's icon :ref:`Texture`. +Sets the given column's icon :ref:`Texture2D`. ---- diff --git a/classes/class_tween.rst b/classes/class_tween.rst index c92112019..e8f411410 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -18,6 +18,8 @@ Description Tweens are useful for animations requiring a numerical property to be interpolated over a range of values. The name *tween* comes from *in-betweening*, an animation technique where you specify *keyframes* and the computer interpolates the frames that appear between them. +``Tween`` is more suited than :ref:`AnimationPlayer` for animations where you don't know the final values in advance. For example, interpolating a dynamically-chosen camera zoom value is best done with a ``Tween`` node; it would be difficult to do the same thing with an :ref:`AnimationPlayer` node. + Here is a brief usage example that causes a 2D node to move smoothly between two positions: :: @@ -46,51 +48,51 @@ Properties Methods ------- -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_runtime` **(** **)** const | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_all` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset_all` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume_all` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`seek` **(** :ref:`float` time **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_active` **(** :ref:`bool` active **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`start` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop_all` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tell` **(** **)** const | -+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`follow_method` **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`StringName` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_runtime` **(** **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`Object` object, :ref:`StringName` key="" **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_all` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** :ref:`Object` object, :ref:`StringName` key="" **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset_all` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resume` **(** :ref:`Object` object, :ref:`StringName` key="" **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resume_all` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` time **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_active` **(** :ref:`bool` active **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** :ref:`Object` object, :ref:`StringName` key="" **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_all` **(** **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Object` initial, :ref:`StringName` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tell` **(** **)** const | ++---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -266,7 +268,7 @@ Method Descriptions .. _class_Tween_method_follow_method: -- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **follow_method** **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`StringName` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Follows ``method`` of ``object`` and applies the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are called with consecutive values. @@ -276,7 +278,7 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Follows ``property`` of ``object`` and applies it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. @@ -294,7 +296,7 @@ Returns the total time needed for all tweens to end. If you have two tweens, one .. _class_Tween_method_interpolate_callback: -- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- void **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. @@ -302,7 +304,7 @@ Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are argum .. _class_Tween_method_interpolate_deferred_callback: -- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- void **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred`). ``arg1``-``arg5`` are arguments to be passed to the callback. @@ -310,7 +312,7 @@ Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar .. _class_Tween_method_interpolate_method: -- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **interpolate_method** **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are called with consecutive values. @@ -320,7 +322,7 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Setting the initial value to ``null`` uses the current value of the property. @@ -340,7 +342,7 @@ Returns ``true`` if any tweens are currently running. .. _class_Tween_method_remove: -- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** +- void **remove** **(** :ref:`Object` object, :ref:`StringName` key="" **)** Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. @@ -348,7 +350,7 @@ Stops animation and removes a tween, given its object and property/method pair. .. _class_Tween_method_remove_all: -- :ref:`bool` **remove_all** **(** **)** +- void **remove_all** **(** **)** Stops animation and removes all tweens. @@ -356,7 +358,7 @@ Stops animation and removes all tweens. .. _class_Tween_method_reset: -- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** +- void **reset** **(** :ref:`Object` object, :ref:`StringName` key="" **)** Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. @@ -364,7 +366,7 @@ Resets a tween to its initial value (the one given, not the one before the tween .. _class_Tween_method_reset_all: -- :ref:`bool` **reset_all** **(** **)** +- void **reset_all** **(** **)** Resets all tweens to their initial values (the ones given, not those before the tween). @@ -372,7 +374,7 @@ Resets all tweens to their initial values (the ones given, not those before the .. _class_Tween_method_resume: -- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** +- void **resume** **(** :ref:`Object` object, :ref:`StringName` key="" **)** Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless ``key`` is specified. @@ -380,7 +382,7 @@ Continues animating a stopped tween, given its object and property/method pair. .. _class_Tween_method_resume_all: -- :ref:`bool` **resume_all** **(** **)** +- void **resume_all** **(** **)** Continues animating all stopped tweens. @@ -388,7 +390,7 @@ Continues animating all stopped tweens. .. _class_Tween_method_seek: -- :ref:`bool` **seek** **(** :ref:`float` time **)** +- void **seek** **(** :ref:`float` time **)** Sets the interpolation to the given ``time`` in seconds. @@ -404,7 +406,7 @@ Activates/deactivates the tween. See also :ref:`stop_all` **start** **(** **)** +- void **start** **(** **)** Starts the tween. You can define animations both before and after this. @@ -412,7 +414,7 @@ Starts the tween. You can define animations both before and after this. .. _class_Tween_method_stop: -- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** +- void **stop** **(** :ref:`Object` object, :ref:`StringName` key="" **)** Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless ``key`` is specified. @@ -420,7 +422,7 @@ Stops a tween, given its object and property/method pair. By default, all tweens .. _class_Tween_method_stop_all: -- :ref:`bool` **stop_all** **(** **)** +- void **stop_all** **(** **)** Stops animating all tweens. @@ -428,7 +430,7 @@ Stops animating all tweens. .. _class_Tween_method_targeting_method: -- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **targeting_method** **(** :ref:`Object` object, :ref:`StringName` method, :ref:`Object` initial, :ref:`StringName` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from the value returned by ``initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values. @@ -438,7 +440,7 @@ Use :ref:`TransitionType` for ``trans_type`` and :ref .. _class_Tween_method_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** +- void **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=2, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst new file mode 100644 index 000000000..0812ec3a9 --- /dev/null +++ b/classes/class_udpserver.rst @@ -0,0 +1,123 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the UDPServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_UDPServer: + +UDPServer +========= + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +Helper class to implement a UDP server. + +Description +----------- + +A simple server that opens a UDP socket and returns connected :ref:`PacketPeerUDP` upon receiving new packets. See also :ref:`PacketPeerUDP.connect_to_host`. + +Below a small example of how it can be used: + +:: + + # server.gd + extends Node + + var server := UDPServer.new() + var peers = [] + + func _ready(): + server.listen(4242) + + func _process(delta): + if server.is_connection_available(): + var peer : PacketPeerUDP = server.take_connection() + var pkt = peer.get_packet() + print("Accepted peer: %s:%s" % [peer.get_packet_ip(), peer.get_packet_port()]) + print("Received data: %s" % [pkt.get_string_from_utf8()]) + # Reply so it knows we received the message. + peer.put_packet(pkt) + # Keep a reference so we can keep contacting the remote peer. + peers.append(peer) + + for i in range(0, peers.size()): + pass # Do something with the connected peers. + + +:: + + # client.gd + extends Node + + var udp := PacketPeerUDP.new() + var connected = false + + func _ready(): + udp.connect_to_host("127.0.0.1", 4242) + + func _process(delta): + if !connected: + # Try to contact server + udp.put_packet("The answer is... 42!".to_utf8()) + if udp.get_available_packet_count() > 0: + print("Connected: %s" % udp.get_packet().get_string_from_utf8()) + connected = true + +Methods +------- + ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connection_available` **(** **)** const | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PacketPeerUDP` | :ref:`take_connection` **(** **)** | ++-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_UDPServer_method_is_connection_available: + +- :ref:`bool` **is_connection_available** **(** **)** const + +Returns ``true`` if a packet with a new address/port combination is received on the socket. + +---- + +.. _class_UDPServer_method_is_listening: + +- :ref:`bool` **is_listening** **(** **)** const + +Returns ``true`` if the socket is open and listening on a port. + +---- + +.. _class_UDPServer_method_listen: + +- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** + +Starts the server by opening a UDP socket listening on the given port. You can optionally specify a ``bind_address`` to only listen for packets sent to that address. See also :ref:`PacketPeerUDP.listen`. + +---- + +.. _class_UDPServer_method_stop: + +- void **stop** **(** **)** + +Stops the server, closing the UDP socket if open. Will not disconnect any connected :ref:`PacketPeerUDP`. + +---- + +.. _class_UDPServer_method_take_connection: + +- :ref:`PacketPeerUDP` **take_connection** **(** **)** + +Returns a :ref:`PacketPeerUDP` connected to the address/port combination of the first packet in queue. Will return ``null`` if no packet is in queue. See also :ref:`PacketPeerUDP.connect_to_host`. + diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index e1af2e1ed..61412964f 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -48,39 +48,39 @@ If you don't need to register a method, you can leave :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_history` **(** :ref:`bool` increase_version=true **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_action` **(** **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_version` **(** **)** const | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_redo` **(** **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_undo` **(** **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_commiting_action` **(** **)** const | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`redo` **(** **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`undo` **(** **)** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`StringName` method, ... **)** vararg | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`StringName` method, ... **)** vararg | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_history` **(** :ref:`bool` increase_version=true **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`commit_action` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_version` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_redo` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_undo` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_commiting_action` **(** **)** const | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`redo` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`undo` **(** **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -115,7 +115,7 @@ Method Descriptions .. _class_UndoRedo_method_add_do_method: -- void **add_do_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg +- void **add_do_method** **(** :ref:`Object` object, :ref:`StringName` method, ... **)** vararg Register a method that will be called when the action is committed. @@ -123,7 +123,7 @@ Register a method that will be called when the action is committed. .. _class_UndoRedo_method_add_do_property: -- void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_do_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** Register a property value change for "do". @@ -139,7 +139,7 @@ Register a reference for "do" that will be erased if the "do" history is lost. T .. _class_UndoRedo_method_add_undo_method: -- void **add_undo_method** **(** :ref:`Object` object, :ref:`String` method, ... **)** vararg +- void **add_undo_method** **(** :ref:`Object` object, :ref:`StringName` method, ... **)** vararg Register a method that will be called when the action is undone. @@ -147,7 +147,7 @@ Register a method that will be called when the action is undone. .. _class_UndoRedo_method_add_undo_property: -- void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_undo_property** **(** :ref:`Object` object, :ref:`StringName` property, :ref:`Variant` value **)** Register a property value change for "undo". diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 078ee7d4f..7153c97a6 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -262,7 +262,7 @@ Adds a mapping to forward the external ``port`` (between 1 and 65535) on the def If ``internal_port`` is ``0`` (the default), the same port number is used for both the external and the internal port (the ``port`` value). -The description (``desc``) is shown in some router UIs and can be used to point out which application added the mapping, and the lifetime of the mapping can be limited by ``duration``. However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. +The description (``desc``) is shown in some router UIs and can be used to point out which application added the mapping. The mapping's lease duration can be limited by specifying a ``duration`` (in seconds). However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. See :ref:`UPNPResult` for possible return values. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index b244b3409..db0c1c076 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -9,13 +9,15 @@ Vector2 ======= -Vector used for 2D math. +Vector used for 2D math using floating point coordinates. Description ----------- 2-element structure that can be used to represent positions in 2D space or any other pair of numeric values. +It uses floating point coordinates. + Tutorials --------- @@ -33,6 +35,8 @@ Properties Methods ------- ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`Vector2i` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -172,9 +176,15 @@ Method Descriptions .. _class_Vector2_method_Vector2: +- :ref:`Vector2` **Vector2** **(** :ref:`Vector2i` from **)** + +Constructs a new ``Vector2`` from :ref:`Vector2i`. + +---- + - :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** -Constructs a new Vector2 from the given ``x`` and ``y``. +Constructs a new ``Vector2`` from the given ``x`` and ``y``. ---- diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst new file mode 100644 index 000000000..a541265b7 --- /dev/null +++ b/classes/class_vector2i.rst @@ -0,0 +1,84 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Vector2i.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Vector2i: + +Vector2i +======== + +Vector used for 2D math using integer coordinates. + +Description +----------- + +2-element structure that can be used to represent positions in 2D space or any other pair of numeric values. + +It uses integer coordinates. + +Tutorials +--------- + +- :doc:`../tutorials/math/index` + +Methods +------- + ++---------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`int` x, :ref:`int` y **)** | ++---------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2` from **)** | ++---------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Constants +--------- + +.. _class_Vector2i_constant_AXIS_X: + +.. _class_Vector2i_constant_AXIS_Y: + +.. _class_Vector2i_constant_ZERO: + +.. _class_Vector2i_constant_ONE: + +.. _class_Vector2i_constant_LEFT: + +.. _class_Vector2i_constant_RIGHT: + +.. _class_Vector2i_constant_UP: + +.. _class_Vector2i_constant_DOWN: + +- **AXIS_X** = **0** --- Enumerated value for the X axis. + +- **AXIS_Y** = **1** --- Enumerated value for the Y axis. + +- **ZERO** = **Vector2i( 0, 0 )** --- Zero vector. + +- **ONE** = **Vector2i( 1, 1 )** --- One vector. + +- **LEFT** = **Vector2i( -1, 0 )** --- Left unit vector. + +- **RIGHT** = **Vector2i( 1, 0 )** --- Right unit vector. + +- **UP** = **Vector2i( 0, -1 )** --- Up unit vector. + +- **DOWN** = **Vector2i( 0, 1 )** --- Down unit vector. + +Method Descriptions +------------------- + +.. _class_Vector2i_method_Vector2i: + +- :ref:`Vector2i` **Vector2i** **(** :ref:`int` x, :ref:`int` y **)** + +Constructs a new ``Vector2i`` from the given ``x`` and ``y``. + +---- + +- :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** + +Constructs a new ``Vector2i`` from :ref:`Vector2`. The floating point coordinates will be truncated. + diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 081eca313..1f6a22964 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -9,13 +9,15 @@ Vector3 ======= -Vector used for 3D math. +Vector used for 3D math using floating point coordinates. Description ----------- 3-element structure that can be used to represent positions in 3D space or any other pair of numeric values. +It uses floating point coordinates. + Tutorials --------- @@ -35,6 +37,8 @@ Properties Methods ------- ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`Vector3i` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -198,9 +202,15 @@ Method Descriptions .. _class_Vector3_method_Vector3: +- :ref:`Vector3` **Vector3** **(** :ref:`Vector3i` from **)** + +Constructs a new ``Vector3`` from :ref:`Vector3i`. + +---- + - :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** -Returns a Vector3 with the given components. +Returns a ``Vector3`` with the given components. ---- diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst new file mode 100644 index 000000000..de3d6caac --- /dev/null +++ b/classes/class_vector3i.rst @@ -0,0 +1,96 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the Vector3i.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_Vector3i: + +Vector3i +======== + +Vector used for 3D math using integer coordinates. + +Description +----------- + +3-element structure that can be used to represent positions in 3D space or any other pair of numeric values. + +It uses integer coordinates. + +Tutorials +--------- + +- :doc:`../tutorials/math/index` + +Methods +------- + ++---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** | ++---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`Vector3i` **(** :ref:`Vector3` from **)** | ++---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +Constants +--------- + +.. _class_Vector3i_constant_AXIS_X: + +.. _class_Vector3i_constant_AXIS_Y: + +.. _class_Vector3i_constant_AXIS_Z: + +.. _class_Vector3i_constant_ZERO: + +.. _class_Vector3i_constant_ONE: + +.. _class_Vector3i_constant_LEFT: + +.. _class_Vector3i_constant_RIGHT: + +.. _class_Vector3i_constant_UP: + +.. _class_Vector3i_constant_DOWN: + +.. _class_Vector3i_constant_FORWARD: + +.. _class_Vector3i_constant_BACK: + +- **AXIS_X** = **0** --- Enumerated value for the X axis. + +- **AXIS_Y** = **1** --- Enumerated value for the Y axis. + +- **AXIS_Z** = **2** --- Enumerated value for the Z axis. + +- **ZERO** = **Vector3i( 0, 0, 0 )** --- Zero vector. + +- **ONE** = **Vector3i( 1, 1, 1 )** --- One vector. + +- **LEFT** = **Vector3i( -1, 0, 0 )** --- Left unit vector. + +- **RIGHT** = **Vector3i( 1, 0, 0 )** --- Right unit vector. + +- **UP** = **Vector3i( 0, 1, 0 )** --- Up unit vector. + +- **DOWN** = **Vector3i( 0, -1, 0 )** --- Down unit vector. + +- **FORWARD** = **Vector3i( 0, 0, -1 )** --- Forward unit vector. + +- **BACK** = **Vector3i( 0, 0, 1 )** --- Back unit vector. + +Method Descriptions +------------------- + +.. _class_Vector3i_method_Vector3i: + +- :ref:`Vector3i` **Vector3i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** + +Returns a ``Vector3i`` with the given components. + +---- + +- :ref:`Vector3i` **Vector3i** **(** :ref:`Vector3` from **)** + +Constructs a new ``Vector3i`` from :ref:`Vector3`. The floating point coordinates will be truncated. + diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 7370c2b49..4e434b99a 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -23,42 +23,42 @@ Supported video formats are `WebM `_ (:ref:`VideoS Properties ---------- -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`audio_track` | ``0`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`autoplay` | ``false`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`buffering_msec` | ``500`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`bus` | ``"Master"`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`expand` | ``true`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`paused` | ``false`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`VideoStream` | :ref:`stream` | | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`stream_position` | | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`volume` | | -+---------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`float` | :ref:`volume_db` | ``0.0`` | -+---------------------------------------+--------------------------------------------------------------------+--------------+ ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`int` | :ref:`audio_track` | ``0`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`autoplay` | ``false`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`int` | :ref:`buffering_msec` | ``500`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`bus` | ``@"Master"`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`expand` | ``true`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`paused` | ``false`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`VideoStream` | :ref:`stream` | | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`stream_position` | | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`volume` | | ++---------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`float` | :ref:`volume_db` | ``0.0`` | ++---------------------------------------+--------------------------------------------------------------------+---------------+ Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** **)** | -+-------------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------------+----------------------------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_stream_name` **(** **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_video_texture` **(** **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-----------------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** **)** | ++-----------------------------------+----------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-----------------------------------+----------------------------------------------------------------------------------------+ Signals ------- @@ -122,10 +122,10 @@ Amount of time in milliseconds to store in buffer while playing. .. _class_VideoPlayer_property_bus: -- :ref:`String` **bus** +- :ref:`StringName` **bus** +-----------+----------------+ -| *Default* | ``"Master"`` | +| *Default* | ``@"Master"`` | +-----------+----------------+ | *Setter* | set_bus(value) | +-----------+----------------+ @@ -237,9 +237,9 @@ Returns the video stream's name, or ``""`` if no video stream is assi .. _class_VideoPlayer_method_get_video_texture: -- :ref:`Texture` **get_video_texture** **(** **)** const +- :ref:`Texture2D` **get_video_texture** **(** **)** const -Returns the current frame as a :ref:`Texture`. +Returns the current frame as a :ref:`Texture2D`. ---- diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 0d301eb9d..dd8ea9be6 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -38,67 +38,61 @@ Tutorials Properties ---------- -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ -| :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:`DebugDraw` | :ref:`debug_draw` | ``0`` | -+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+---------------------+ -| :ref:`bool` | :ref:`disable_3d` | ``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:`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:`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:`DefaultCanvasItemTextureFilter` | :ref:`canvas_item_default_texture_filter` | ``1`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DefaultCanvasItemTextureRepeat` | :ref:`canvas_item_default_texture_repeat` | ``0`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`Transform2D` | :ref:`canvas_transform` | | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`DebugDraw` | :ref:`debug_draw` | ``0`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :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:`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:`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:`Vector2` | :ref:`size` | ``Vector2( 0, 0 )`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`size_override_stretch` | ``false`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`bool` | :ref:`transparent_bg` | ``false`` | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`World` | :ref:`world` | | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ +| :ref:`World2D` | :ref:`world_2d` | | ++-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------+ Methods ------- @@ -279,15 +273,43 @@ enum **RenderInfo**: .. _class_Viewport_constant_DEBUG_DRAW_WIREFRAME: +.. _class_Viewport_constant_DEBUG_DRAW_GI_PROBE_ALBEDO: + +.. _class_Viewport_constant_DEBUG_DRAW_GI_PROBE_LIGHTING: + +.. _class_Viewport_constant_DEBUG_DRAW_GI_PROBE_EMISSION: + +.. _class_Viewport_constant_DEBUG_DRAW_SHADOW_ATLAS: + +.. _class_Viewport_constant_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS: + +.. _class_Viewport_constant_DEBUG_DRAW_SCENE_LUMINANCE: + +.. _class_Viewport_constant_DEBUG_DRAW_SSAO: + enum **DebugDraw**: - **DEBUG_DRAW_DISABLED** = **0** --- Objects are displayed normally. - **DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information. -- **DEBUG_DRAW_OVERDRAW** = **2** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. +- **DEBUG_DRAW_OVERDRAW** = **3** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. -- **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. +- **DEBUG_DRAW_WIREFRAME** = **4** --- Objects are displayed in wireframe style. + +- **DEBUG_DRAW_GI_PROBE_ALBEDO** = **6** + +- **DEBUG_DRAW_GI_PROBE_LIGHTING** = **7** + +- **DEBUG_DRAW_GI_PROBE_EMISSION** = **8** + +- **DEBUG_DRAW_SHADOW_ATLAS** = **9** + +- **DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = **10** + +- **DEBUG_DRAW_SCENE_LUMINANCE** = **11** + +- **DEBUG_DRAW_SSAO** = **12** ---- @@ -317,28 +339,6 @@ enum **MSAA**: ---- -.. _enum_Viewport_Usage: - -.. _class_Viewport_constant_USAGE_2D: - -.. _class_Viewport_constant_USAGE_2D_NO_SAMPLING: - -.. _class_Viewport_constant_USAGE_3D: - -.. _class_Viewport_constant_USAGE_3D_NO_EFFECTS: - -enum **Usage**: - -- **USAGE_2D** = **0** --- Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes. - -- **USAGE_2D_NO_SAMPLING** = **1** --- Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the :ref:`Usage` types, this requires the least VRAM. - -- **USAGE_3D** = **2** --- Allocates full buffers for drawing 3D scenes and all 3D effects including buffers needed for 2D scenes and effects. - -- **USAGE_3D_NO_EFFECTS** = **3** --- Allocates buffers needed for drawing 3D scenes. But does not allocate buffers needed for reading from the screen and post-processing effects. Saves some VRAM. - ----- - .. _enum_Viewport_ClearMode: .. _class_Viewport_constant_CLEAR_MODE_ALWAYS: @@ -355,6 +355,54 @@ enum **ClearMode**: - **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** --- Clear the render target next frame, then switch to :ref:`CLEAR_MODE_NEVER`. +---- + +.. _enum_Viewport_DefaultCanvasItemTextureFilter: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX: + +enum **DefaultCanvasItemTextureFilter**: + +- **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = **0** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = **1** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **2** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **3** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX** = **4** + +---- + +.. _enum_Viewport_DefaultCanvasItemTextureRepeat: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR: + +.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX: + +enum **DefaultCanvasItemTextureRepeat**: + +- **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = **0** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = **1** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = **2** + +- **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX** = **3** + Property Descriptions --------------------- @@ -406,6 +454,34 @@ If ``true``, the viewport will process 3D audio streams. ---- +.. _class_Viewport_property_canvas_item_default_texture_filter: + +- :ref:`DefaultCanvasItemTextureFilter` **canvas_item_default_texture_filter** + ++-----------+-----------------------------------------------+ +| *Default* | ``1`` | ++-----------+-----------------------------------------------+ +| *Setter* | set_default_canvas_item_texture_filter(value) | ++-----------+-----------------------------------------------+ +| *Getter* | get_default_canvas_item_texture_filter() | ++-----------+-----------------------------------------------+ + +---- + +.. _class_Viewport_property_canvas_item_default_texture_repeat: + +- :ref:`DefaultCanvasItemTextureRepeat` **canvas_item_default_texture_repeat** + ++-----------+-----------------------------------------------+ +| *Default* | ``0`` | ++-----------+-----------------------------------------------+ +| *Setter* | set_default_canvas_item_texture_repeat(value) | ++-----------+-----------------------------------------------+ +| *Getter* | get_default_canvas_item_texture_repeat() | ++-----------+-----------------------------------------------+ + +---- + .. _class_Viewport_property_canvas_transform: - :ref:`Transform2D` **canvas_transform** @@ -436,22 +512,6 @@ The overlay mode for test rendered geometry in debug purposes. ---- -.. _class_Viewport_property_disable_3d: - -- :ref:`bool` **disable_3d** - -+-----------+-----------------------+ -| *Default* | ``false`` | -+-----------+-----------------------+ -| *Setter* | set_disable_3d(value) | -+-----------+-----------------------+ -| *Getter* | is_3d_disabled() | -+-----------+-----------------------+ - -If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. - ----- - .. _class_Viewport_property_global_canvas_transform: - :ref:`Transform2D` **global_canvas_transform** @@ -512,38 +572,6 @@ If ``true``, the GUI controls on the viewport will lay pixel perfectly. ---- -.. _class_Viewport_property_hdr: - -- :ref:`bool` **hdr** - -+-----------+----------------+ -| *Default* | ``true`` | -+-----------+----------------+ -| *Setter* | set_hdr(value) | -+-----------+----------------+ -| *Getter* | get_hdr() | -+-----------+----------------+ - -If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. High Dynamic Range allows the viewport to receive values that are outside the 0-1 range. In Godot HDR uses 16 bits, meaning it does not store the full range of a floating point number. - ----- - -.. _class_Viewport_property_keep_3d_linear: - -- :ref:`bool` **keep_3d_linear** - -+-----------+---------------------------+ -| *Default* | ``false`` | -+-----------+---------------------------+ -| *Setter* | set_keep_3d_linear(value) | -+-----------+---------------------------+ -| *Getter* | get_keep_3d_linear() | -+-----------+---------------------------+ - -If ``true``, the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. - ----- - .. _class_Viewport_property_msaa: - :ref:`MSAA` **msaa** @@ -640,22 +668,6 @@ The update mode when viewport used as a render target. ---- -.. _class_Viewport_property_render_target_v_flip: - -- :ref:`bool` **render_target_v_flip** - -+-----------+------------------+ -| *Default* | ``false`` | -+-----------+------------------+ -| *Setter* | set_vflip(value) | -+-----------+------------------+ -| *Getter* | get_vflip() | -+-----------+------------------+ - -If ``true``, the result of rendering will be flipped vertically. - ----- - .. _class_Viewport_property_shadow_atlas_quad_0: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** @@ -786,22 +798,6 @@ If ``true``, the viewport should render its background as transparent. ---- -.. _class_Viewport_property_usage: - -- :ref:`Usage` **usage** - -+-----------+------------------+ -| *Default* | ``2`` | -+-----------+------------------+ -| *Setter* | set_usage(value) | -+-----------+------------------+ -| *Getter* | get_usage() | -+-----------+------------------+ - -The rendering mode of viewport. - ----- - .. _class_Viewport_property_world: - :ref:`World` **world** @@ -909,7 +905,7 @@ Returns the size override set with :ref:`set_size_override` is flipped vertically. You can use :ref:`Image.flip_y` on the result of :ref:`Texture.get_data` to flip it back, for example: +**Note:** Due to the way OpenGL works, the resulting :ref:`ViewportTexture` is flipped vertically. You can use :ref:`Image.flip_y` on the result of :ref:`Texture2D.get_data` to flip it back, for example: :: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 285b4598f..90b3d3435 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -9,22 +9,20 @@ ViewportTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Texture which displays the content of a :ref:`Viewport`. Description ----------- -Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture`. This can be used to mix controls, 2D, and 3D elements in the same scene. +Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture2D`. This can be used to mix controls, 2D, and 3D elements in the same scene. To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` method on the target viewport. Properties ---------- -+---------------------------------+--------------------------------------------------------------------+------------------+ -| :ref:`int` | flags | **O:** ``0`` | +---------------------------------+--------------------------------------------------------------------+------------------+ | :ref:`bool` | resource_local_to_scene | **O:** ``true`` | +---------------------------------+--------------------------------------------------------------------+------------------+ diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index bbedd763c..05b923f9f 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -11,7 +11,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLightmap`, :ref:`GIProbe`, :ref:`GeometryInstance`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` +**Inherited By:** :ref:`GIProbe`, :ref:`GeometryInstance`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` Parent of all visual 3D nodes. diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index f3d4622f8..74f4b750a 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -30,91 +30,91 @@ Tutorials Methods ------- -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_function` **(** :ref:`String` name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_function` **(** :ref:`String` name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_variable` **(** :ref:`String` name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_custom_signal` **(** :ref:`StringName` name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_function` **(** :ref:`StringName` name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_node` **(** :ref:`StringName` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_variable` **(** :ref:`StringName` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_add_argument` **(** :ref:`StringName` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`StringName` name, :ref:`int` argidx **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`StringName` name, :ref:`int` argidx **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_remove_argument` **(** :ref:`StringName` name, :ref:`int` argidx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`String` argname **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`custom_signal_swap_argument` **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`int` withidx **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_connect` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`data_disconnect` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`StringName` func, :ref:`int` id **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`StringName` func, :ref:`int` id **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_function` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`StringName` func, :ref:`int` id **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_variable` **(** :ref:`StringName` name **)** const | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_custom_signal` **(** :ref:`StringName` name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_function` **(** :ref:`StringName` name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_node` **(** :ref:`StringName` func, :ref:`int` id **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_variable` **(** :ref:`StringName` name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_custom_signal` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_function` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_variable` **(** :ref:`StringName` name, :ref:`StringName` new_name **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_connect` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sequence_disconnect` **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_function_scroll` **(** :ref:`StringName` name, :ref:`Vector2` ofs **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_base_type` **(** :ref:`StringName` type **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_node_position` **(** :ref:`StringName` func, :ref:`int` id, :ref:`Vector2` position **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_default_value` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_export` **(** :ref:`StringName` name, :ref:`bool` enable **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_variable_info` **(** :ref:`StringName` name, :ref:`Dictionary` value **)** | ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -130,7 +130,7 @@ Method Descriptions .. _class_VisualScript_method_add_custom_signal: -- void **add_custom_signal** **(** :ref:`String` name **)** +- void **add_custom_signal** **(** :ref:`StringName` name **)** Add a custom signal with the specified name to the VisualScript. @@ -138,7 +138,7 @@ Add a custom signal with the specified name to the VisualScript. .. _class_VisualScript_method_add_function: -- void **add_function** **(** :ref:`String` name **)** +- void **add_function** **(** :ref:`StringName` name **)** Add a function with the specified name to the VisualScript. @@ -146,7 +146,7 @@ Add a function with the specified name to the VisualScript. .. _class_VisualScript_method_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`StringName` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** Add a node to a function of the VisualScript. @@ -154,7 +154,7 @@ Add a node to a function of the VisualScript. .. _class_VisualScript_method_add_variable: -- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** +- void **add_variable** **(** :ref:`StringName` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. @@ -162,7 +162,7 @@ Add a variable to the VisualScript, optionally giving it a default value or mark .. _class_VisualScript_method_custom_signal_add_argument: -- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** +- void **custom_signal_add_argument** **(** :ref:`StringName` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** Add an argument to a custom signal added with :ref:`add_custom_signal`. @@ -170,7 +170,7 @@ Add an argument to a custom signal added with :ref:`add_custom_signal` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const +- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`StringName` name **)** const Get the count of a custom signal's arguments. @@ -178,7 +178,7 @@ Get the count of a custom signal's arguments. .. _class_VisualScript_method_custom_signal_get_argument_name: -- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`StringName` name, :ref:`int` argidx **)** const Get the name of a custom signal's argument. @@ -186,7 +186,7 @@ Get the name of a custom signal's argument. .. _class_VisualScript_method_custom_signal_get_argument_type: -- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`StringName` name, :ref:`int` argidx **)** const Get the type of a custom signal's argument. @@ -194,7 +194,7 @@ Get the type of a custom signal's argument. .. _class_VisualScript_method_custom_signal_remove_argument: -- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** +- void **custom_signal_remove_argument** **(** :ref:`StringName` name, :ref:`int` argidx **)** Remove a specific custom signal's argument. @@ -202,7 +202,7 @@ Remove a specific custom signal's argument. .. _class_VisualScript_method_custom_signal_set_argument_name: -- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** +- void **custom_signal_set_argument_name** **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`String` argname **)** Rename a custom signal's argument. @@ -210,7 +210,7 @@ Rename a custom signal's argument. .. _class_VisualScript_method_custom_signal_set_argument_type: -- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** +- void **custom_signal_set_argument_type** **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** Change the type of a custom signal's argument. @@ -218,7 +218,7 @@ Change the type of a custom signal's argument. .. _class_VisualScript_method_custom_signal_swap_argument: -- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** +- void **custom_signal_swap_argument** **(** :ref:`StringName` name, :ref:`int` argidx, :ref:`int` withidx **)** Swap two of the arguments of a custom signal. @@ -226,7 +226,7 @@ Swap two of the arguments of a custom signal. .. _class_VisualScript_method_data_connect: -- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_connect** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``. @@ -234,7 +234,7 @@ Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed .. _class_VisualScript_method_data_disconnect: -- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_disconnect** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Disconnect two data ports previously connected with :ref:`data_connect`. @@ -242,7 +242,7 @@ Disconnect two data ports previously connected with :ref:`data_connect` **get_function_node_id** **(** :ref:`String` name **)** const +- :ref:`int` **get_function_node_id** **(** :ref:`StringName` name **)** const Returns the id of a function's entry point node. @@ -250,7 +250,7 @@ Returns the id of a function's entry point node. .. _class_VisualScript_method_get_function_scroll: -- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_function_scroll** **(** :ref:`StringName` name **)** const Returns the position of the center of the screen for a given function. @@ -258,7 +258,7 @@ Returns the position of the center of the screen for a given function. .. _class_VisualScript_method_get_node: -- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`VisualScriptNode` **get_node** **(** :ref:`StringName` func, :ref:`int` id **)** const Returns a node given its id and its function. @@ -266,7 +266,7 @@ Returns a node given its id and its function. .. _class_VisualScript_method_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`StringName` func, :ref:`int` id **)** const Returns a node's position in pixels. @@ -274,7 +274,7 @@ Returns a node's position in pixels. .. _class_VisualScript_method_get_variable_default_value: -- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_variable_default_value** **(** :ref:`StringName` name **)** const Returns the default (initial) value of a variable. @@ -282,7 +282,7 @@ Returns the default (initial) value of a variable. .. _class_VisualScript_method_get_variable_export: -- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const +- :ref:`bool` **get_variable_export** **(** :ref:`StringName` name **)** const Returns whether a variable is exported. @@ -290,7 +290,7 @@ Returns whether a variable is exported. .. _class_VisualScript_method_get_variable_info: -- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const +- :ref:`Dictionary` **get_variable_info** **(** :ref:`StringName` name **)** const Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. @@ -298,7 +298,7 @@ Returns the information for a given variable as a dictionary. The information in .. _class_VisualScript_method_has_custom_signal: -- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const +- :ref:`bool` **has_custom_signal** **(** :ref:`StringName` name **)** const Returns whether a signal exists with the specified name. @@ -306,7 +306,7 @@ Returns whether a signal exists with the specified name. .. _class_VisualScript_method_has_data_connection: -- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **has_data_connection** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const Returns whether the specified data ports are connected. @@ -314,7 +314,7 @@ Returns whether the specified data ports are connected. .. _class_VisualScript_method_has_function: -- :ref:`bool` **has_function** **(** :ref:`String` name **)** const +- :ref:`bool` **has_function** **(** :ref:`StringName` name **)** const Returns whether a function exists with the specified name. @@ -322,7 +322,7 @@ Returns whether a function exists with the specified name. .. _class_VisualScript_method_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`bool` **has_node** **(** :ref:`StringName` func, :ref:`int` id **)** const Returns whether a node exists with the given id. @@ -330,7 +330,7 @@ Returns whether a node exists with the given id. .. _class_VisualScript_method_has_sequence_connection: -- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const +- :ref:`bool` **has_sequence_connection** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const Returns whether the specified sequence ports are connected. @@ -338,7 +338,7 @@ Returns whether the specified sequence ports are connected. .. _class_VisualScript_method_has_variable: -- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const +- :ref:`bool` **has_variable** **(** :ref:`StringName` name **)** const Returns whether a variable exists with the specified name. @@ -346,7 +346,7 @@ Returns whether a variable exists with the specified name. .. _class_VisualScript_method_remove_custom_signal: -- void **remove_custom_signal** **(** :ref:`String` name **)** +- void **remove_custom_signal** **(** :ref:`StringName` name **)** Remove a custom signal with the given name. @@ -354,7 +354,7 @@ Remove a custom signal with the given name. .. _class_VisualScript_method_remove_function: -- void **remove_function** **(** :ref:`String` name **)** +- void **remove_function** **(** :ref:`StringName` name **)** Remove a specific function and its nodes from the script. @@ -362,7 +362,7 @@ Remove a specific function and its nodes from the script. .. _class_VisualScript_method_remove_node: -- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** +- void **remove_node** **(** :ref:`StringName` func, :ref:`int` id **)** Remove a specific node. @@ -370,7 +370,7 @@ Remove a specific node. .. _class_VisualScript_method_remove_variable: -- void **remove_variable** **(** :ref:`String` name **)** +- void **remove_variable** **(** :ref:`StringName` name **)** Remove a variable with the given name. @@ -378,7 +378,7 @@ Remove a variable with the given name. .. _class_VisualScript_method_rename_custom_signal: -- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_custom_signal** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** Change the name of a custom signal. @@ -386,7 +386,7 @@ Change the name of a custom signal. .. _class_VisualScript_method_rename_function: -- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_function** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** Change the name of a function. @@ -394,7 +394,7 @@ Change the name of a function. .. _class_VisualScript_method_rename_variable: -- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_variable** **(** :ref:`StringName` name, :ref:`StringName` new_name **)** Change the name of a variable. @@ -402,7 +402,7 @@ Change the name of a variable. .. _class_VisualScript_method_sequence_connect: -- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_connect** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``. @@ -412,7 +412,7 @@ Unlike :ref:`data_connect`, there isn't .. _class_VisualScript_method_sequence_disconnect: -- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_disconnect** **(** :ref:`StringName` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Disconnect two sequence ports previously connected with :ref:`sequence_connect`. @@ -420,7 +420,7 @@ Disconnect two sequence ports previously connected with :ref:`sequence_connect` name, :ref:`Vector2` ofs **)** +- void **set_function_scroll** **(** :ref:`StringName` name, :ref:`Vector2` ofs **)** Position the center of the screen for a function. @@ -428,7 +428,7 @@ Position the center of the screen for a function. .. _class_VisualScript_method_set_instance_base_type: -- void **set_instance_base_type** **(** :ref:`String` type **)** +- void **set_instance_base_type** **(** :ref:`StringName` type **)** Set the base type of the script. @@ -436,7 +436,7 @@ Set the base type of the script. .. _class_VisualScript_method_set_node_position: -- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`StringName` func, :ref:`int` id, :ref:`Vector2` position **)** Position a node on the screen. @@ -444,7 +444,7 @@ Position a node on the screen. .. _class_VisualScript_method_set_variable_default_value: -- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_variable_default_value** **(** :ref:`StringName` name, :ref:`Variant` value **)** Change the default (initial) value of a variable. @@ -452,7 +452,7 @@ Change the default (initial) value of a variable. .. _class_VisualScript_method_set_variable_export: -- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** +- void **set_variable_export** **(** :ref:`StringName` name, :ref:`bool` enable **)** Change whether a variable is exported. @@ -460,7 +460,7 @@ Change whether a variable is exported. .. _class_VisualScript_method_set_variable_info: -- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** +- void **set_variable_info** **(** :ref:`StringName` name, :ref:`Dictionary` value **)** Set a variable's info, using the same format as :ref:`get_variable_info`. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index ee75b6dd3..7772fd740 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -24,7 +24,7 @@ Properties +-----------------------------------------------------+----------------------------------------------------------------------------+-------+ | :ref:`Variant.Type` | :ref:`basic_type` | ``0`` | +-----------------------------------------------------+----------------------------------------------------------------------------+-------+ -| :ref:`String` | :ref:`constant` | | +| :ref:`StringName` | :ref:`constant` | | +-----------------------------------------------------+----------------------------------------------------------------------------+-------+ Property Descriptions @@ -48,7 +48,7 @@ The type to get the constant from. .. _class_VisualScriptBasicTypeConstant_property_constant: -- :ref:`String` **constant** +- :ref:`StringName` **constant** +----------+--------------------------------+ | *Setter* | set_basic_type_constant(value) | diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 6f295d75b..d94d397ce 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -80,7 +80,7 @@ Enumerations .. _class_VisualScriptBuiltinFunc_constant_MATH_EASE: -.. _class_VisualScriptBuiltinFunc_constant_MATH_DECIMALS: +.. _class_VisualScriptBuiltinFunc_constant_MATH_STEP_DECIMALS: .. _class_VisualScriptBuiltinFunc_constant_MATH_STEPIFY: @@ -220,7 +220,7 @@ enum **BuiltinFunc**: - **MATH_EASE** = **23** --- Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. -- **MATH_DECIMALS** = **24** --- Return the number of digit places after the decimal that the first non-zero digit occurs. +- **MATH_STEP_DECIMALS** = **24** --- Return the number of digit places after the decimal that the first non-zero digit occurs. - **MATH_STEPIFY** = **25** --- Return the input snapped to a given step. @@ -294,9 +294,9 @@ enum **BuiltinFunc**: - **STR_TO_VAR** = **60** --- Deserialize a :ref:`Variant` from a string serialized using :ref:`VAR_TO_STR`. -- **VAR_TO_BYTES** = **61** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. +- **VAR_TO_BYTES** = **61** --- Serialize a :ref:`Variant` to a :ref:`PackedByteArray`. -- **BYTES_TO_VAR** = **62** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using :ref:`VAR_TO_BYTES`. +- **BYTES_TO_VAR** = **62** --- Deserialize a :ref:`Variant` from a :ref:`PackedByteArray` serialized using :ref:`VAR_TO_BYTES`. - **COLORN** = **63** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index b30b6c61f..2c591558b 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -29,21 +29,21 @@ none Properties ---------- -+-----------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+-----------------------------+----------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`constant` | ``""`` | -+-----------------------------+----------------------------------------------------------------------+--------------+ ++-------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++-------------------------------------+----------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`constant` | ``@""`` | ++-------------------------------------+----------------------------------------------------------------------+---------------+ Property Descriptions --------------------- .. _class_VisualScriptClassConstant_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ @@ -56,10 +56,10 @@ The constant's parent class. .. _class_VisualScriptClassConstant_property_constant: -- :ref:`String` **constant** +- :ref:`StringName` **constant** +-----------+---------------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------------+ | *Setter* | set_class_constant(value) | +-----------+---------------------------+ diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index da922eb0d..84ce25253 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -29,19 +29,19 @@ Emits a specified signal when it is executed. Properties ---------- -+-----------------------------+-------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`signal` | ``""`` | -+-----------------------------+-------------------------------------------------------------+--------+ ++-------------------------------------+-------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`signal` | ``@""`` | ++-------------------------------------+-------------------------------------------------------------+---------+ Property Descriptions --------------------- .. _class_VisualScriptEmitSignal_property_signal: -- :ref:`String` **signal** +- :ref:`StringName` **signal** +-----------+-------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+-------------------+ | *Setter* | set_signal(value) | +-----------+-------------------+ diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index ae0b53b77..8a211213e 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -16,27 +16,27 @@ VisualScriptFunctionCall Properties ---------- -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_script` | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`CallMode` | :ref:`call_mode` | ``0`` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`function` | ``""`` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`NodePath` | :ref:`node_path` | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | ``0`` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`singleton` | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`int` | :ref:`use_default_args` | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ -| :ref:`bool` | :ref:`validate` | ``true`` | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------+ ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`String` | :ref:`base_script` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`CallMode` | :ref:`call_mode` | ``0`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`function` | ``@""`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`NodePath` | :ref:`node_path` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`RPCCallMode` | :ref:`rpc_call_mode` | ``0`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`singleton` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`int` | :ref:`use_default_args` | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ +| :ref:`bool` | :ref:`validate` | ``true`` | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------+ Enumerations ------------ @@ -108,10 +108,10 @@ Property Descriptions .. _class_VisualScriptFunctionCall_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ @@ -148,10 +148,10 @@ Property Descriptions .. _class_VisualScriptFunctionCall_property_function: -- :ref:`String` **function** +- :ref:`StringName` **function** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_function(value) | +-----------+---------------------+ @@ -188,7 +188,7 @@ Property Descriptions .. _class_VisualScriptFunctionCall_property_singleton: -- :ref:`String` **singleton** +- :ref:`StringName` **singleton** +----------+----------------------+ | *Setter* | set_singleton(value) | diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index f75e9ef17..500b8129e 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -16,11 +16,11 @@ VisualScriptInputAction Properties ---------- -+------------------------------------------------+--------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`action` | ``""`` | -+------------------------------------------------+--------------------------------------------------------------+--------+ -| :ref:`Mode` | :ref:`mode` | ``0`` | -+------------------------------------------------+--------------------------------------------------------------+--------+ ++------------------------------------------------+--------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`action` | ``@""`` | ++------------------------------------------------+--------------------------------------------------------------+---------+ +| :ref:`Mode` | :ref:`mode` | ``0`` | ++------------------------------------------------+--------------------------------------------------------------+---------+ Enumerations ------------ @@ -50,10 +50,10 @@ Property Descriptions .. _class_VisualScriptInputAction_property_action: -- :ref:`String` **action** +- :ref:`StringName` **action** +-----------+------------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+------------------------+ | *Setter* | set_action_name(value) | +-----------+------------------------+ diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 641e807b0..e4cae493e 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -29,11 +29,11 @@ none Properties ---------- -+-----------------------------------------------------+---------------------------------------------------------------+-----------------+ -| :ref:`Variant.Type` | :ref:`type` | ``0`` | -+-----------------------------------------------------+---------------------------------------------------------------+-----------------+ -| :ref:`String` | :ref:`var_name` | ``"new_local"`` | -+-----------------------------------------------------+---------------------------------------------------------------+-----------------+ ++-----------------------------------------------------+---------------------------------------------------------------+------------------+ +| :ref:`Variant.Type` | :ref:`type` | ``0`` | ++-----------------------------------------------------+---------------------------------------------------------------+------------------+ +| :ref:`StringName` | :ref:`var_name` | ``@"new_local"`` | ++-----------------------------------------------------+---------------------------------------------------------------+------------------+ Property Descriptions --------------------- @@ -56,10 +56,10 @@ The local variable's type. .. _class_VisualScriptLocalVar_property_var_name: -- :ref:`String` **var_name** +- :ref:`StringName` **var_name** +-----------+---------------------+ -| *Default* | ``"new_local"`` | +| *Default* | ``@"new_local"`` | +-----------+---------------------+ | *Setter* | set_var_name(value) | +-----------+---------------------+ diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 4d38325b5..3ca92fd1c 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -33,11 +33,11 @@ Changes a local variable's value to the given input. The new value is also provi Properties ---------- -+-----------------------------------------------------+------------------------------------------------------------------+-----------------+ -| :ref:`Variant.Type` | :ref:`type` | ``0`` | -+-----------------------------------------------------+------------------------------------------------------------------+-----------------+ -| :ref:`String` | :ref:`var_name` | ``"new_local"`` | -+-----------------------------------------------------+------------------------------------------------------------------+-----------------+ ++-----------------------------------------------------+------------------------------------------------------------------+------------------+ +| :ref:`Variant.Type` | :ref:`type` | ``0`` | ++-----------------------------------------------------+------------------------------------------------------------------+------------------+ +| :ref:`StringName` | :ref:`var_name` | ``@"new_local"`` | ++-----------------------------------------------------+------------------------------------------------------------------+------------------+ Property Descriptions --------------------- @@ -60,10 +60,10 @@ The local variable's type. .. _class_VisualScriptLocalVarSet_property_var_name: -- :ref:`String` **var_name** +- :ref:`StringName` **var_name** +-----------+---------------------+ -| *Default* | ``"new_local"`` | +| *Default* | ``@"new_local"`` | +-----------+---------------------+ | *Setter* | set_var_name(value) | +-----------+---------------------+ diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 1e7931b6c..caa59faa3 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -16,21 +16,21 @@ VisualScriptPropertyGet Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_script` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`index` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`NodePath` | :ref:`node_path` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`property` | ``""`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`CallMode` | :ref:`set_mode` | ``0`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`String` | :ref:`base_script` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`index` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`property` | ``@""`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`CallMode` | :ref:`set_mode` | ``0`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ Enumerations ------------ @@ -68,10 +68,10 @@ Property Descriptions .. _class_VisualScriptPropertyGet_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ @@ -94,7 +94,7 @@ Property Descriptions .. _class_VisualScriptPropertyGet_property_index: -- :ref:`String` **index** +- :ref:`StringName` **index** +----------+------------------+ | *Setter* | set_index(value) | @@ -118,10 +118,10 @@ Property Descriptions .. _class_VisualScriptPropertyGet_property_property: -- :ref:`String` **property** +- :ref:`StringName` **property** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_property(value) | +-----------+---------------------+ diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 92ab29cbd..e692f659f 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -16,23 +16,23 @@ VisualScriptPropertySet Properties ---------- -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`AssignOp` | :ref:`assign_op` | ``0`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_script` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`Variant.Type` | :ref:`basic_type` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`index` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`NodePath` | :ref:`node_path` | | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`property` | ``""`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ -| :ref:`CallMode` | :ref:`set_mode` | ``0`` | -+--------------------------------------------------------+------------------------------------------------------------------------+--------------+ ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`AssignOp` | :ref:`assign_op` | ``0`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`String` | :ref:`base_script` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`Variant.Type` | :ref:`basic_type` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`index` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`property` | ``@""`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ +| :ref:`CallMode` | :ref:`set_mode` | ``0`` | ++--------------------------------------------------------+------------------------------------------------------------------------+---------------+ Enumerations ------------ @@ -138,10 +138,10 @@ Property Descriptions .. _class_VisualScriptPropertySet_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ @@ -164,7 +164,7 @@ Property Descriptions .. _class_VisualScriptPropertySet_property_index: -- :ref:`String` **index** +- :ref:`StringName` **index** +----------+------------------+ | *Setter* | set_index(value) | @@ -188,10 +188,10 @@ Property Descriptions .. _class_VisualScriptPropertySet_property_property: -- :ref:`String` **property** +- :ref:`StringName` **property** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_property(value) | +-----------+---------------------+ diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 8f74b7060..cd1935280 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -16,11 +16,11 @@ VisualScriptTypeCast Properties ---------- -+-----------------------------+---------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_script` | ``""`` | -+-----------------------------+---------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+-----------------------------+---------------------------------------------------------------------+--------------+ ++-------------------------------------+---------------------------------------------------------------------+---------------+ +| :ref:`String` | :ref:`base_script` | ``""`` | ++-------------------------------------+---------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++-------------------------------------+---------------------------------------------------------------------+---------------+ Property Descriptions --------------------- @@ -41,10 +41,10 @@ Property Descriptions .. _class_VisualScriptTypeCast_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 32a308daf..c891c5985 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -29,19 +29,19 @@ none Properties ---------- -+-----------------------------+------------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`var_name` | ``""`` | -+-----------------------------+------------------------------------------------------------------+--------+ ++-------------------------------------+------------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`var_name` | ``@""`` | ++-------------------------------------+------------------------------------------------------------------+---------+ Property Descriptions --------------------- .. _class_VisualScriptVariableGet_property_var_name: -- :ref:`String` **var_name** +- :ref:`StringName` **var_name** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_variable(value) | +-----------+---------------------+ diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 219d6ca08..d25764a97 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -31,19 +31,19 @@ Changes a variable's value to the given input. Properties ---------- -+-----------------------------+------------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`var_name` | ``""`` | -+-----------------------------+------------------------------------------------------------------+--------+ ++-------------------------------------+------------------------------------------------------------------+---------+ +| :ref:`StringName` | :ref:`var_name` | ``@""`` | ++-------------------------------------+------------------------------------------------------------------+---------+ Property Descriptions --------------------- .. _class_VisualScriptVariableSet_property_var_name: -- :ref:`String` **var_name** +- :ref:`StringName` **var_name** +-----------+---------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+---------------------+ | *Setter* | set_variable(value) | +-----------+---------------------+ diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index b9a006d8c..9e54b2a9f 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -16,15 +16,15 @@ VisualScriptYieldSignal Properties ---------- -+--------------------------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`base_type` | ``"Object"`` | -+--------------------------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`CallMode` | :ref:`call_mode` | ``0`` | -+--------------------------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`NodePath` | :ref:`node_path` | | -+--------------------------------------------------------+--------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`signal` | ``""`` | -+--------------------------------------------------------+--------------------------------------------------------------------+--------------+ ++--------------------------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`base_type` | ``@"Object"`` | ++--------------------------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`CallMode` | :ref:`call_mode` | ``0`` | ++--------------------------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`NodePath` | :ref:`node_path` | | ++--------------------------------------------------------+--------------------------------------------------------------------+---------------+ +| :ref:`StringName` | :ref:`signal` | ``@""`` | ++--------------------------------------------------------+--------------------------------------------------------------------+---------------+ Enumerations ------------ @@ -50,10 +50,10 @@ Property Descriptions .. _class_VisualScriptYieldSignal_property_base_type: -- :ref:`String` **base_type** +- :ref:`StringName` **base_type** +-----------+----------------------+ -| *Default* | ``"Object"`` | +| *Default* | ``@"Object"`` | +-----------+----------------------+ | *Setter* | set_base_type(value) | +-----------+----------------------+ @@ -90,10 +90,10 @@ Property Descriptions .. _class_VisualScriptYieldSignal_property_signal: -- :ref:`String` **signal** +- :ref:`StringName` **signal** +-----------+-------------------+ -| *Default* | ``""`` | +| *Default* | ``@""`` | +-----------+-------------------+ | *Setter* | set_signal(value) | +-----------+-------------------+ diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 77ab55d67..19310b5b4 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -42,737 +42,555 @@ Tutorials Methods ------- -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` texture, :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map, :ref:`bool` antialiased=false, :ref:`bool` antialiasing_use_indices=false **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`directional_light_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`environment_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`finish` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_sync` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`init` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 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_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_use_gi` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param_default` **(** :ref:`RID` material, :ref:`String` parameter **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`omni_light_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`spot_light_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sync` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_bind` **(** :ref:`RID` texture, :ref:`int` number **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`environment_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0, :ref:`Color` ao_color=Color( 0, 0, 0, 1 ) **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_end, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`finish` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_sync` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_changed` **(** **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`init` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_use_gi` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PackedByteArray` octree **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`StringName` parameter **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`Dictionary` lods={ }, :ref:`int` compress_format=31744 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer` **(** :ref:`RID` multimesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_buffer` **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`StringName` method, :ref:`Variant` userdata **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` name **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shader_get_param_default` **(** :ref:`RID` material, :ref:`StringName` parameter **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`sky_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` panorama **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_2d_create` **(** :ref:`Image` image **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`texture_2d_get` **(** :ref:`RID` texture **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_create` **(** **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -794,95 +612,51 @@ Emitted at the beginning of the frame, before the VisualServer updates all the V Enumerations ------------ -.. _enum_VisualServer_CubeMapSide: +.. _enum_VisualServer_TextureLayeredType: -.. _class_VisualServer_constant_CUBEMAP_LEFT: +.. _class_VisualServer_constant_TEXTURE_LAYERED_2D_ARRAY: -.. _class_VisualServer_constant_CUBEMAP_RIGHT: +.. _class_VisualServer_constant_TEXTURE_LAYERED_CUBEMAP: -.. _class_VisualServer_constant_CUBEMAP_BOTTOM: +.. _class_VisualServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY: -.. _class_VisualServer_constant_CUBEMAP_TOP: +enum **TextureLayeredType**: -.. _class_VisualServer_constant_CUBEMAP_FRONT: +- **TEXTURE_LAYERED_2D_ARRAY** = **0** -.. _class_VisualServer_constant_CUBEMAP_BACK: +- **TEXTURE_LAYERED_CUBEMAP** = **1** -enum **CubeMapSide**: - -- **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap. - -- **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap. - -- **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap. - -- **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap. - -- **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap. - -- **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap. +- **TEXTURE_LAYERED_CUBEMAP_ARRAY** = **2** ---- -.. _enum_VisualServer_TextureType: +.. _enum_VisualServer_CubeMapLayer: -.. _class_VisualServer_constant_TEXTURE_TYPE_2D: +.. _class_VisualServer_constant_CUBEMAP_LAYER_LEFT: -.. _class_VisualServer_constant_TEXTURE_TYPE_CUBEMAP: +.. _class_VisualServer_constant_CUBEMAP_LAYER_RIGHT: -.. _class_VisualServer_constant_TEXTURE_TYPE_2D_ARRAY: +.. _class_VisualServer_constant_CUBEMAP_LAYER_BOTTOM: -.. _class_VisualServer_constant_TEXTURE_TYPE_3D: +.. _class_VisualServer_constant_CUBEMAP_LAYER_TOP: -enum **TextureType**: +.. _class_VisualServer_constant_CUBEMAP_LAYER_FRONT: -- **TEXTURE_TYPE_2D** = **0** --- Normal texture with 2 dimensions, width and height. +.. _class_VisualServer_constant_CUBEMAP_LAYER_BACK: -- **TEXTURE_TYPE_CUBEMAP** = **1** --- Texture made up of six faces, can be looked up with a ``vec3`` in shader. +enum **CubeMapLayer**: -- **TEXTURE_TYPE_2D_ARRAY** = **2** --- An array of 2-dimensional textures. +- **CUBEMAP_LAYER_LEFT** = **0** -- **TEXTURE_TYPE_3D** = **3** --- A 3-dimensional texture with width, height, and depth. +- **CUBEMAP_LAYER_RIGHT** = **1** ----- +- **CUBEMAP_LAYER_BOTTOM** = **2** -.. _enum_VisualServer_TextureFlags: +- **CUBEMAP_LAYER_TOP** = **3** -.. _class_VisualServer_constant_TEXTURE_FLAG_MIPMAPS: +- **CUBEMAP_LAYER_FRONT** = **4** -.. _class_VisualServer_constant_TEXTURE_FLAG_REPEAT: - -.. _class_VisualServer_constant_TEXTURE_FLAG_FILTER: - -.. _class_VisualServer_constant_TEXTURE_FLAG_ANISOTROPIC_FILTER: - -.. _class_VisualServer_constant_TEXTURE_FLAG_CONVERT_TO_LINEAR: - -.. _class_VisualServer_constant_TEXTURE_FLAG_MIRRORED_REPEAT: - -.. _class_VisualServer_constant_TEXTURE_FLAG_USED_FOR_STREAMING: - -.. _class_VisualServer_constant_TEXTURE_FLAGS_DEFAULT: - -enum **TextureFlags**: - -- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generates mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. - -- **TEXTURE_FLAG_REPEAT** = **2** --- Repeats the texture (instead of clamp to edge). - -- **TEXTURE_FLAG_FILTER** = **4** --- Uses a magnifying filter, to enable smooth zooming in of the texture. - -- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Uses anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios. - -This results in better-looking textures when viewed from oblique angles. - -- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts the texture to the sRGB color space. - -- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeats the texture with alternate sections mirrored. - -- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. - -- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. :ref:`TEXTURE_FLAG_MIPMAPS`, :ref:`TEXTURE_FLAG_REPEAT` and :ref:`TEXTURE_FLAG_FILTER` are enabled. +- **CUBEMAP_LAYER_BACK** = **5** ---- @@ -974,8 +748,6 @@ enum **ArrayType**: .. _class_VisualServer_constant_ARRAY_FORMAT_INDEX: -.. _class_VisualServer_constant_ARRAY_COMPRESS_VERTEX: - .. _class_VisualServer_constant_ARRAY_COMPRESS_NORMAL: .. _class_VisualServer_constant_ARRAY_COMPRESS_TANGENT: @@ -986,15 +758,11 @@ enum **ArrayType**: .. _class_VisualServer_constant_ARRAY_COMPRESS_TEX_UV2: -.. _class_VisualServer_constant_ARRAY_COMPRESS_BONES: - -.. _class_VisualServer_constant_ARRAY_COMPRESS_WEIGHTS: - .. _class_VisualServer_constant_ARRAY_COMPRESS_INDEX: .. _class_VisualServer_constant_ARRAY_FLAG_USE_2D_VERTICES: -.. _class_VisualServer_constant_ARRAY_FLAG_USE_16_BIT_BONES: +.. _class_VisualServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE: .. _class_VisualServer_constant_ARRAY_COMPRESS_DEFAULT: @@ -1018,8 +786,6 @@ enum **ArrayFormat**: - **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark an index array. -- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array. - - **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array. - **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array. @@ -1030,17 +796,13 @@ enum **ArrayFormat**: - **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates. -- **ARRAY_COMPRESS_BONES** = **32768** --- Flag used to mark a compressed bone array. - -- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array. - - **ARRAY_COMPRESS_INDEX** = **131072** --- Flag used to mark a compressed index array. - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices. -- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16-bit bones instead of 8-bit. +- **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = **1048576** -- **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags :ref:`ARRAY_COMPRESS_VERTEX`, :ref:`ARRAY_COMPRESS_NORMAL`, :ref:`ARRAY_COMPRESS_TANGENT`, :ref:`ARRAY_COMPRESS_COLOR`, :ref:`ARRAY_COMPRESS_TEX_UV`, :ref:`ARRAY_COMPRESS_TEX_UV2` and :ref:`ARRAY_COMPRESS_WEIGHTS` quickly. +- **ARRAY_COMPRESS_DEFAULT** = **31744** --- Used to set flags :ref:`ARRAY_COMPRESS_NORMAL`, :ref:`ARRAY_COMPRESS_TANGENT`, :ref:`ARRAY_COMPRESS_COLOR`, :ref:`ARRAY_COMPRESS_TEX_UV` and :ref:`ARRAY_COMPRESS_TEX_UV2` quickly. ---- @@ -1052,14 +814,10 @@ enum **ArrayFormat**: .. _class_VisualServer_constant_PRIMITIVE_LINE_STRIP: -.. _class_VisualServer_constant_PRIMITIVE_LINE_LOOP: - .. _class_VisualServer_constant_PRIMITIVE_TRIANGLES: .. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_STRIP: -.. _class_VisualServer_constant_PRIMITIVE_TRIANGLE_FAN: - .. _class_VisualServer_constant_PRIMITIVE_MAX: enum **PrimitiveType**: @@ -1070,15 +828,11 @@ enum **PrimitiveType**: - **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end. -- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex). +- **PRIMITIVE_TRIANGLES** = **3** --- Primitive to draw consists of triangles. -- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles. +- **PRIMITIVE_TRIANGLE_STRIP** = **4** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). - -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). - -- **PRIMITIVE_MAX** = **7** --- Represents the size of the :ref:`PrimitiveType` enum. +- **PRIMITIVE_MAX** = **5** --- Represents the size of the :ref:`PrimitiveType` enum. ---- @@ -1096,6 +850,20 @@ enum **BlendShapeMode**: ---- +.. _enum_VisualServer_MultimeshTransformFormat: + +.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_2D: + +.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_3D: + +enum **MultimeshTransformFormat**: + +- **MULTIMESH_TRANSFORM_2D** = **0** --- Use :ref:`Transform2D` to store MultiMesh transform. + +- **MULTIMESH_TRANSFORM_3D** = **1** --- Use :ref:`Transform` to store MultiMesh transform. + +---- + .. _enum_VisualServer_LightType: .. _class_VisualServer_constant_LIGHT_DIRECTIONAL: @@ -1118,6 +886,8 @@ enum **LightType**: .. _class_VisualServer_constant_LIGHT_PARAM_ENERGY: +.. _class_VisualServer_constant_LIGHT_PARAM_INDIRECT_ENERGY: + .. _class_VisualServer_constant_LIGHT_PARAM_SPECULAR: .. _class_VisualServer_constant_LIGHT_PARAM_RANGE: @@ -1138,6 +908,8 @@ enum **LightType**: .. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET: +.. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_FADE_START: + .. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS: .. _class_VisualServer_constant_LIGHT_PARAM_SHADOW_BIAS: @@ -1150,6 +922,8 @@ enum **LightParam**: - **LIGHT_PARAM_ENERGY** = **0** --- The light's energy. +- **LIGHT_PARAM_INDIRECT_ENERGY** = **1** + - **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity. - **LIGHT_PARAM_RANGE** = **3** --- The light's range. @@ -1170,13 +944,15 @@ enum **LightParam**: - **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11** --- Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest. -- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12** --- Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts. +- **LIGHT_PARAM_SHADOW_FADE_START** = **12** -- **LIGHT_PARAM_SHADOW_BIAS** = **13** --- Bias the shadow lookup to fix self-shadowing artifacts. +- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **13** --- Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts. -- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** --- Increases bias on further splits to fix self-shadowing that only occurs far away from the camera. +- **LIGHT_PARAM_SHADOW_BIAS** = **14** --- Bias the shadow lookup to fix self-shadowing artifacts. -- **LIGHT_PARAM_MAX** = **15** --- Represents the size of the :ref:`LightParam` enum. +- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **15** --- Increases bias on further splits to fix self-shadowing that only occurs far away from the camera. + +- **LIGHT_PARAM_MAX** = **16** --- Represents the size of the :ref:`LightParam` enum. ---- @@ -1194,20 +970,6 @@ enum **LightOmniShadowMode**: ---- -.. _enum_VisualServer_LightOmniShadowDetail: - -.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_VERTICAL: - -.. _class_VisualServer_constant_LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL: - -enum **LightOmniShadowDetail**: - -- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** --- Use more detail vertically when computing shadow map. - -- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** --- Use more detail horizontally when computing shadow map. - ----- - .. _enum_VisualServer_LightDirectionalShadowMode: .. _class_VisualServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: @@ -1240,6 +1002,38 @@ enum **LightDirectionalShadowDepthRangeMode**: ---- +.. _enum_VisualServer_ReflectionProbeUpdateMode: + +.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE: + +.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS: + +enum **ReflectionProbeUpdateMode**: + +- **REFLECTION_PROBE_UPDATE_ONCE** = **0** --- Reflection probe will update reflections once and then stop. + +- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** --- Reflection probe will update each frame. This mode is necessary to capture moving objects. + +---- + +.. _enum_VisualServer_ParticlesDrawOrder: + +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_INDEX: + +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_LIFETIME: + +.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: + +enum **ParticlesDrawOrder**: + +- **PARTICLES_DRAW_ORDER_INDEX** = **0** --- Draw particles in the order that they appear in the particles array. + +- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** --- Sort particles based on their lifetime. + +- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** --- Sort particles based on their distance to the camera. + +---- + .. _enum_VisualServer_ViewportUpdateMode: .. _class_VisualServer_constant_VIEWPORT_UPDATE_DISABLED: @@ -1314,28 +1108,6 @@ enum **ViewportMSAA**: ---- -.. _enum_VisualServer_ViewportUsage: - -.. _class_VisualServer_constant_VIEWPORT_USAGE_2D: - -.. _class_VisualServer_constant_VIEWPORT_USAGE_2D_NO_SAMPLING: - -.. _class_VisualServer_constant_VIEWPORT_USAGE_3D: - -.. _class_VisualServer_constant_VIEWPORT_USAGE_3D_NO_EFFECTS: - -enum **ViewportUsage**: - -- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples. - -- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample. - -- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. - -- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. - ----- - .. _enum_VisualServer_ViewportRenderInfo: .. _class_VisualServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: @@ -1376,19 +1148,279 @@ enum **ViewportRenderInfo**: .. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED: +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING: + .. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: .. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_GI_PROBE_ALBEDO: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_GI_PROBE_LIGHTING: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_GI_PROBE_EMISSION: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_SSAO: + +.. _class_VisualServer_constant_VIEWPORT_DEBUG_DRAW_ROUGHNESS_LIMITER: + enum **ViewportDebugDraw**: - **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting. - **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded. -- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. +- **VIEWPORT_DEBUG_DRAW_LIGHTING** = **2** -- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. +- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **3** --- Overwrites clear color to ``(0,0,0,0)``. + +- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **4** --- Debug draw draws objects in wireframe. + +- **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = **5** + +- **VIEWPORT_DEBUG_DRAW_GI_PROBE_ALBEDO** = **6** + +- **VIEWPORT_DEBUG_DRAW_GI_PROBE_LIGHTING** = **7** + +- **VIEWPORT_DEBUG_DRAW_GI_PROBE_EMISSION** = **8** + +- **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = **9** + +- **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = **10** + +- **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = **11** + +- **VIEWPORT_DEBUG_DRAW_SSAO** = **12** + +- **VIEWPORT_DEBUG_DRAW_ROUGHNESS_LIMITER** = **13** + +---- + +.. _enum_VisualServer_SkyMode: + +.. _class_VisualServer_constant_SKY_MODE_QUALITY: + +.. _class_VisualServer_constant_SKY_MODE_REALTIME: + +enum **SkyMode**: + +- **SKY_MODE_QUALITY** = **0** + +- **SKY_MODE_REALTIME** = **1** + +---- + +.. _enum_VisualServer_EnvironmentBG: + +.. _class_VisualServer_constant_ENV_BG_CLEAR_COLOR: + +.. _class_VisualServer_constant_ENV_BG_COLOR: + +.. _class_VisualServer_constant_ENV_BG_SKY: + +.. _class_VisualServer_constant_ENV_BG_CANVAS: + +.. _class_VisualServer_constant_ENV_BG_KEEP: + +.. _class_VisualServer_constant_ENV_BG_CAMERA_FEED: + +.. _class_VisualServer_constant_ENV_BG_MAX: + +enum **EnvironmentBG**: + +- **ENV_BG_CLEAR_COLOR** = **0** --- Use the clear color as background. + +- **ENV_BG_COLOR** = **1** --- Use a specified color as the background. + +- **ENV_BG_SKY** = **2** --- Use a sky resource for the background. + +- **ENV_BG_CANVAS** = **3** --- Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world. + +- **ENV_BG_KEEP** = **4** --- Do not clear the background, use whatever was rendered last frame as the background. + +- **ENV_BG_CAMERA_FEED** = **5** --- Displays a camera feed in the background. + +- **ENV_BG_MAX** = **6** --- Represents the size of the :ref:`EnvironmentBG` enum. + +---- + +.. _enum_VisualServer_EnvironmentAmbientSource: + +.. _class_VisualServer_constant_ENV_AMBIENT_SOURCE_BG: + +.. _class_VisualServer_constant_ENV_AMBIENT_SOURCE_DISABLED: + +.. _class_VisualServer_constant_ENV_AMBIENT_SOURCE_COLOR: + +.. _class_VisualServer_constant_ENV_AMBIENT_SOURCE_SKY: + +enum **EnvironmentAmbientSource**: + +- **ENV_AMBIENT_SOURCE_BG** = **0** + +- **ENV_AMBIENT_SOURCE_DISABLED** = **1** + +- **ENV_AMBIENT_SOURCE_COLOR** = **2** + +- **ENV_AMBIENT_SOURCE_SKY** = **3** + +---- + +.. _enum_VisualServer_EnvironmentReflectionSource: + +.. _class_VisualServer_constant_ENV_REFLECTION_SOURCE_BG: + +.. _class_VisualServer_constant_ENV_REFLECTION_SOURCE_DISABLED: + +.. _class_VisualServer_constant_ENV_REFLECTION_SOURCE_SKY: + +enum **EnvironmentReflectionSource**: + +- **ENV_REFLECTION_SOURCE_BG** = **0** + +- **ENV_REFLECTION_SOURCE_DISABLED** = **1** + +- **ENV_REFLECTION_SOURCE_SKY** = **2** + +---- + +.. _enum_VisualServer_EnvironmentGlowBlendMode: + +.. _class_VisualServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE: + +.. _class_VisualServer_constant_ENV_GLOW_BLEND_MODE_SCREEN: + +.. _class_VisualServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT: + +.. _class_VisualServer_constant_ENV_GLOW_BLEND_MODE_REPLACE: + +.. _class_VisualServer_constant_ENV_GLOW_BLEND_MODE_MIX: + +enum **EnvironmentGlowBlendMode**: + +- **ENV_GLOW_BLEND_MODE_ADDITIVE** = **0** + +- **ENV_GLOW_BLEND_MODE_SCREEN** = **1** + +- **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = **2** + +- **ENV_GLOW_BLEND_MODE_REPLACE** = **3** + +- **ENV_GLOW_BLEND_MODE_MIX** = **4** + +---- + +.. _enum_VisualServer_EnvironmentToneMapper: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_LINEAR: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC: + +.. _class_VisualServer_constant_ENV_TONE_MAPPER_ACES: + +enum **EnvironmentToneMapper**: + +- **ENV_TONE_MAPPER_LINEAR** = **0** --- Output color as they came in. + +- **ENV_TONE_MAPPER_REINHARD** = **1** --- Use the Reinhard tonemapper. + +- **ENV_TONE_MAPPER_FILMIC** = **2** --- Use the filmic tonemapper. + +- **ENV_TONE_MAPPER_ACES** = **3** --- Use the ACES tonemapper. + +---- + +.. _enum_VisualServer_EnvironmentSSAOBlur: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_DISABLED: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_1x1: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_2x2: + +.. _class_VisualServer_constant_ENV_SSAO_BLUR_3x3: + +enum **EnvironmentSSAOBlur**: + +- **ENV_SSAO_BLUR_DISABLED** = **0** --- Disables the blur set for SSAO. Will make SSAO look noisier. + +- **ENV_SSAO_BLUR_1x1** = **1** --- Perform a 1x1 blur on the SSAO output. + +- **ENV_SSAO_BLUR_2x2** = **2** --- Performs a 2x2 blur on the SSAO output. + +- **ENV_SSAO_BLUR_3x3** = **3** --- Performs a 3x3 blur on the SSAO output. Use this for smoothest SSAO. + +---- + +.. _enum_VisualServer_EnvironmentSSAOQuality: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_LOW: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_MEDIUM: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_HIGH: + +.. _class_VisualServer_constant_ENV_SSAO_QUALITY_ULTRA: + +enum **EnvironmentSSAOQuality**: + +- **ENV_SSAO_QUALITY_LOW** = **0** --- Lowest quality of screen space ambient occlusion. + +- **ENV_SSAO_QUALITY_MEDIUM** = **1** --- Medium quality screen space ambient occlusion. + +- **ENV_SSAO_QUALITY_HIGH** = **2** --- Highest quality screen space ambient occlusion. + +- **ENV_SSAO_QUALITY_ULTRA** = **3** + +---- + +.. _enum_VisualServer_DOFBlurQuality: + +.. _class_VisualServer_constant_DOF_BLUR_QUALITY_VERY_LOW: + +.. _class_VisualServer_constant_DOF_BLUR_QUALITY_LOW: + +.. _class_VisualServer_constant_DOF_BLUR_QUALITY_MEDIUM: + +.. _class_VisualServer_constant_DOF_BLUR_QUALITY_HIGH: + +enum **DOFBlurQuality**: + +- **DOF_BLUR_QUALITY_VERY_LOW** = **0** + +- **DOF_BLUR_QUALITY_LOW** = **1** + +- **DOF_BLUR_QUALITY_MEDIUM** = **2** + +- **DOF_BLUR_QUALITY_HIGH** = **3** + +---- + +.. _enum_VisualServer_DOFBokehShape: + +.. _class_VisualServer_constant_DOF_BOKEH_BOX: + +.. _class_VisualServer_constant_DOF_BOKEH_HEXAGON: + +.. _class_VisualServer_constant_DOF_BOKEH_CIRCLE: + +enum **DOFBokehShape**: + +- **DOF_BOKEH_BOX** = **0** + +- **DOF_BOKEH_HEXAGON** = **1** + +- **DOF_BOKEH_CIRCLE** = **2** ---- @@ -1468,6 +1500,8 @@ enum **InstanceType**: .. _class_VisualServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: +.. _class_VisualServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI: + .. _class_VisualServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: .. _class_VisualServer_constant_INSTANCE_FLAG_MAX: @@ -1476,9 +1510,11 @@ enum **InstanceFlags**: - **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** --- Allows the instance to be used in baked lighting. -- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** --- When set, manually requests to draw geometry on next frame. +- **INSTANCE_FLAG_USE_DYNAMIC_GI** = **1** -- **INSTANCE_FLAG_MAX** = **2** --- Represents the size of the :ref:`InstanceFlags` enum. +- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **2** --- When set, manually requests to draw geometry on next frame. + +- **INSTANCE_FLAG_MAX** = **3** --- Represents the size of the :ref:`InstanceFlags` enum. ---- @@ -1522,6 +1558,70 @@ enum **NinePatchAxisMode**: ---- +.. _enum_VisualServer_CanvasItemTextureFilter: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX: + +enum **CanvasItemTextureFilter**: + +- **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = **0** + +- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = **1** + +- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = **2** + +- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **3** + +- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **4** + +- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = **5** + +- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = **6** + +- **CANVAS_ITEM_TEXTURE_FILTER_MAX** = **7** + +---- + +.. _enum_VisualServer_CanvasItemTextureRepeat: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR: + +.. _class_VisualServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX: + +enum **CanvasItemTextureRepeat**: + +- **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = **0** + +- **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = **1** + +- **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = **2** + +- **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = **3** + +- **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = **4** + +---- + .. _enum_VisualServer_CanvasLightMode: .. _class_VisualServer_constant_CANVAS_LIGHT_MODE_ADD: @@ -1548,29 +1648,21 @@ enum **CanvasLightMode**: .. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_NONE: -.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF3: - .. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF5: -.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF7: - -.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF9: - .. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_PCF13: +.. _class_VisualServer_constant_CANVAS_LIGHT_FILTER_MAX: + enum **CanvasLightShadowFilter**: - **CANVAS_LIGHT_FILTER_NONE** = **0** --- Do not apply a filter to canvas light shadows. -- **CANVAS_LIGHT_FILTER_PCF3** = **1** --- Use PCF3 filtering to filter canvas light shadows. +- **CANVAS_LIGHT_FILTER_PCF5** = **1** --- Use PCF5 filtering to filter canvas light shadows. -- **CANVAS_LIGHT_FILTER_PCF5** = **2** --- Use PCF5 filtering to filter canvas light shadows. +- **CANVAS_LIGHT_FILTER_PCF13** = **2** --- Use PCF13 filtering to filter canvas light shadows. -- **CANVAS_LIGHT_FILTER_PCF7** = **3** --- Use PCF7 filtering to filter canvas light shadows. - -- **CANVAS_LIGHT_FILTER_PCF9** = **4** --- Use PCF9 filtering to filter canvas light shadows. - -- **CANVAS_LIGHT_FILTER_PCF13** = **5** --- Use PCF13 filtering to filter canvas light shadows. +- **CANVAS_LIGHT_FILTER_MAX** = **3** ---- @@ -1628,7 +1720,7 @@ enum **RenderInfo**: - **INFO_DRAW_CALLS_IN_FRAME** = **5** --- The amount of draw calls in frame. -- **INFO_USAGE_VIDEO_MEM_TOTAL** = **6** --- Unimplemented in the GLES2 and GLES3 rendering backends, always returns 0. +- **INFO_USAGE_VIDEO_MEM_TOTAL** = **6** --- Unimplemented in the GLES2 rendering backend, always returns 0. - **INFO_VIDEO_MEM_USED** = **7** --- The amount of video memory used, i.e. texture and vertex memory combined. @@ -1650,224 +1742,6 @@ enum **Features**: - **FEATURE_MULTITHREADED** = **1** --- Hardware supports multithreading. This enum is currently unused in Godot 3.x. ----- - -.. _enum_VisualServer_MultimeshTransformFormat: - -.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_2D: - -.. _class_VisualServer_constant_MULTIMESH_TRANSFORM_3D: - -enum **MultimeshTransformFormat**: - -- **MULTIMESH_TRANSFORM_2D** = **0** --- Use :ref:`Transform2D` to store MultiMesh transform. - -- **MULTIMESH_TRANSFORM_3D** = **1** --- Use :ref:`Transform` to store MultiMesh transform. - ----- - -.. _enum_VisualServer_MultimeshColorFormat: - -.. _class_VisualServer_constant_MULTIMESH_COLOR_NONE: - -.. _class_VisualServer_constant_MULTIMESH_COLOR_8BIT: - -.. _class_VisualServer_constant_MULTIMESH_COLOR_FLOAT: - -enum **MultimeshColorFormat**: - -- **MULTIMESH_COLOR_NONE** = **0** --- MultiMesh does not use per-instance color. - -- **MULTIMESH_COLOR_8BIT** = **1** --- MultiMesh color uses 8 bits per component. This packs the color into a single float. - -- **MULTIMESH_COLOR_FLOAT** = **2** --- MultiMesh color uses a float per channel. - ----- - -.. _enum_VisualServer_MultimeshCustomDataFormat: - -.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_NONE: - -.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_8BIT: - -.. _class_VisualServer_constant_MULTIMESH_CUSTOM_DATA_FLOAT: - -enum **MultimeshCustomDataFormat**: - -- **MULTIMESH_CUSTOM_DATA_NONE** = **0** --- MultiMesh does not use custom data. - -- **MULTIMESH_CUSTOM_DATA_8BIT** = **1** --- MultiMesh custom data uses 8 bits per component. This packs the 4-component custom data into a single float. - -- **MULTIMESH_CUSTOM_DATA_FLOAT** = **2** --- MultiMesh custom data uses a float per component. - ----- - -.. _enum_VisualServer_ReflectionProbeUpdateMode: - -.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ONCE: - -.. _class_VisualServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS: - -enum **ReflectionProbeUpdateMode**: - -- **REFLECTION_PROBE_UPDATE_ONCE** = **0** --- Reflection probe will update reflections once and then stop. - -- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** --- Reflection probe will update each frame. This mode is necessary to capture moving objects. - ----- - -.. _enum_VisualServer_ParticlesDrawOrder: - -.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_INDEX: - -.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_LIFETIME: - -.. _class_VisualServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: - -enum **ParticlesDrawOrder**: - -- **PARTICLES_DRAW_ORDER_INDEX** = **0** --- Draw particles in the order that they appear in the particles array. - -- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** --- Sort particles based on their lifetime. - -- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** --- Sort particles based on their distance to the camera. - ----- - -.. _enum_VisualServer_EnvironmentBG: - -.. _class_VisualServer_constant_ENV_BG_CLEAR_COLOR: - -.. _class_VisualServer_constant_ENV_BG_COLOR: - -.. _class_VisualServer_constant_ENV_BG_SKY: - -.. _class_VisualServer_constant_ENV_BG_COLOR_SKY: - -.. _class_VisualServer_constant_ENV_BG_CANVAS: - -.. _class_VisualServer_constant_ENV_BG_KEEP: - -.. _class_VisualServer_constant_ENV_BG_MAX: - -enum **EnvironmentBG**: - -- **ENV_BG_CLEAR_COLOR** = **0** --- Use the clear color as background. - -- **ENV_BG_COLOR** = **1** --- Use a specified color as the background. - -- **ENV_BG_SKY** = **2** --- Use a sky resource for the background. - -- **ENV_BG_COLOR_SKY** = **3** --- Use a custom color for background, but use a sky for shading and reflections. - -- **ENV_BG_CANVAS** = **4** --- Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world. - -- **ENV_BG_KEEP** = **5** --- Do not clear the background, use whatever was rendered last frame as the background. - -- **ENV_BG_MAX** = **7** --- Represents the size of the :ref:`EnvironmentBG` enum. - ----- - -.. _enum_VisualServer_EnvironmentDOFBlurQuality: - -.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_LOW: - -.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_MEDIUM: - -.. _class_VisualServer_constant_ENV_DOF_BLUR_QUALITY_HIGH: - -enum **EnvironmentDOFBlurQuality**: - -- **ENV_DOF_BLUR_QUALITY_LOW** = **0** --- Use lowest blur quality. Fastest, but may look bad. - -- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** --- Use medium blur quality. - -- **ENV_DOF_BLUR_QUALITY_HIGH** = **2** --- Used highest blur quality. Looks the best, but is the slowest. - ----- - -.. _enum_VisualServer_EnvironmentGlowBlendMode: - -.. _class_VisualServer_constant_GLOW_BLEND_MODE_ADDITIVE: - -.. _class_VisualServer_constant_GLOW_BLEND_MODE_SCREEN: - -.. _class_VisualServer_constant_GLOW_BLEND_MODE_SOFTLIGHT: - -.. _class_VisualServer_constant_GLOW_BLEND_MODE_REPLACE: - -enum **EnvironmentGlowBlendMode**: - -- **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Add the effect of the glow on top of the scene. - -- **GLOW_BLEND_MODE_SCREEN** = **1** --- Blends the glow effect with the screen. Does not get as bright as additive. - -- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Produces a subtle color disturbance around objects. - -- **GLOW_BLEND_MODE_REPLACE** = **3** --- Shows the glow effect by itself without the underlying scene. - ----- - -.. _enum_VisualServer_EnvironmentToneMapper: - -.. _class_VisualServer_constant_ENV_TONE_MAPPER_LINEAR: - -.. _class_VisualServer_constant_ENV_TONE_MAPPER_REINHARD: - -.. _class_VisualServer_constant_ENV_TONE_MAPPER_FILMIC: - -.. _class_VisualServer_constant_ENV_TONE_MAPPER_ACES: - -enum **EnvironmentToneMapper**: - -- **ENV_TONE_MAPPER_LINEAR** = **0** --- Output color as they came in. - -- **ENV_TONE_MAPPER_REINHARD** = **1** --- Use the Reinhard tonemapper. - -- **ENV_TONE_MAPPER_FILMIC** = **2** --- Use the filmic tonemapper. - -- **ENV_TONE_MAPPER_ACES** = **3** --- Use the ACES tonemapper. - ----- - -.. _enum_VisualServer_EnvironmentSSAOQuality: - -.. _class_VisualServer_constant_ENV_SSAO_QUALITY_LOW: - -.. _class_VisualServer_constant_ENV_SSAO_QUALITY_MEDIUM: - -.. _class_VisualServer_constant_ENV_SSAO_QUALITY_HIGH: - -enum **EnvironmentSSAOQuality**: - -- **ENV_SSAO_QUALITY_LOW** = **0** --- Lowest quality of screen space ambient occlusion. - -- **ENV_SSAO_QUALITY_MEDIUM** = **1** --- Medium quality screen space ambient occlusion. - -- **ENV_SSAO_QUALITY_HIGH** = **2** --- Highest quality screen space ambient occlusion. - ----- - -.. _enum_VisualServer_EnvironmentSSAOBlur: - -.. _class_VisualServer_constant_ENV_SSAO_BLUR_DISABLED: - -.. _class_VisualServer_constant_ENV_SSAO_BLUR_1x1: - -.. _class_VisualServer_constant_ENV_SSAO_BLUR_2x2: - -.. _class_VisualServer_constant_ENV_SSAO_BLUR_3x3: - -enum **EnvironmentSSAOBlur**: - -- **ENV_SSAO_BLUR_DISABLED** = **0** --- Disables the blur set for SSAO. Will make SSAO look noisier. - -- **ENV_SSAO_BLUR_1x1** = **1** --- Perform a 1x1 blur on the SSAO output. - -- **ENV_SSAO_BLUR_2x2** = **2** --- Performs a 2x2 blur on the SSAO output. - -- **ENV_SSAO_BLUR_3x3** = **3** --- Performs a 3x3 blur on the SSAO output. Use this for smoothest SSAO. - Constants --------- @@ -1998,130 +1872,6 @@ Once finished with your RID, you will want to free the RID using the VisualServe ---- -.. _class_VisualServer_method_canvas_item_add_circle: - -- void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** - -Adds a circle command to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_clip_ignore: - -- void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** - -If ignore is ``true``, the VisualServer does not perform clipping. - ----- - -.. _class_VisualServer_method_canvas_item_add_line: - -- void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** - -Adds a line command to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_mesh: - -- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` texture, :ref:`RID` normal_map **)** - -Adds a mesh command to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_multimesh: - -- void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** - -Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. - ----- - -.. _class_VisualServer_method_canvas_item_add_nine_patch: - -- void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** - -Adds a nine patch image to the :ref:`CanvasItem`'s draw commands. - -See :ref:`NinePatchRect` for more explanation. - ----- - -.. _class_VisualServer_method_canvas_item_add_particles: - -- void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map **)** - -Adds a particle system to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_polygon: - -- void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** - -Adds a polygon to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_polyline: - -- void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** - -Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_primitive: - -- void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** - -Adds a primitive to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_rect: - -- void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** - -Adds a rectangle to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_set_transform: - -- void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** - -Adds a :ref:`Transform2D` command to the :ref:`CanvasItem`'s draw commands. - -This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item. - ----- - -.. _class_VisualServer_method_canvas_item_add_texture_rect: - -- void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** - -Adds a textured rect to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_texture_rect_region: - -- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** - -Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. - ----- - -.. _class_VisualServer_method_canvas_item_add_triangle_array: - -- void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map, :ref:`bool` antialiased=false, :ref:`bool` antialiasing_use_indices=false **)** - -Adds a triangle array to the :ref:`CanvasItem`'s draw commands. - ----- - .. _class_VisualServer_method_canvas_item_clear: - void **canvas_item_clear** **(** :ref:`RID` item **)** @@ -2130,24 +1880,6 @@ Clears the :ref:`CanvasItem` and removes all commands in it. ---- -.. _class_VisualServer_method_canvas_item_create: - -- :ref:`RID` **canvas_item_create** **(** **)** - -Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` VisualServer functions. - -Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid` static method. - ----- - -.. _class_VisualServer_method_canvas_item_set_clip: - -- void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** - -Sets clipping for the :ref:`CanvasItem`. - ----- - .. _class_VisualServer_method_canvas_item_set_copy_to_backbuffer: - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** @@ -2156,30 +1888,6 @@ Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. ---- -.. _class_VisualServer_method_canvas_item_set_custom_rect: - -- void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** - -Defines a custom drawing rectangle for the :ref:`CanvasItem`. - ----- - -.. _class_VisualServer_method_canvas_item_set_distance_field_mode: - -- void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** - -Enables the use of distance fields for GUI elements that are rendering distance field based fonts. - ----- - -.. _class_VisualServer_method_canvas_item_set_draw_behind_parent: - -- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** - -Sets :ref:`CanvasItem` to be drawn behind its parent. - ----- - .. _class_VisualServer_method_canvas_item_set_draw_index: - void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** @@ -2188,14 +1896,6 @@ Sets the index for the :ref:`CanvasItem`. ---- -.. _class_VisualServer_method_canvas_item_set_light_mask: - -- void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** - -The light mask. See :ref:`LightOccluder2D` for more information on light masks. - ----- - .. _class_VisualServer_method_canvas_item_set_material: - void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** @@ -2204,46 +1904,6 @@ Sets a new material to the :ref:`CanvasItem`. ---- -.. _class_VisualServer_method_canvas_item_set_modulate: - -- void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** - -Sets the color that modulates the :ref:`CanvasItem` and its children. - ----- - -.. _class_VisualServer_method_canvas_item_set_parent: - -- void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** - -Sets the parent for the :ref:`CanvasItem`. The parent can be another canvas item, or it can be the root canvas that is attached to the viewport. - ----- - -.. _class_VisualServer_method_canvas_item_set_self_modulate: - -- void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** - -Sets the color that modulates the :ref:`CanvasItem` without children. - ----- - -.. _class_VisualServer_method_canvas_item_set_sort_children_by_y: - -- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** - -Sets if :ref:`CanvasItem`'s children should be sorted by y-position. - ----- - -.. _class_VisualServer_method_canvas_item_set_transform: - -- void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** - -Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. - ----- - .. _class_VisualServer_method_canvas_item_set_use_parent_material: - void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** @@ -2252,14 +1912,6 @@ Sets if the :ref:`CanvasItem` uses its parent's material. ---- -.. _class_VisualServer_method_canvas_item_set_visible: - -- void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** - -Sets if the canvas item (including its children) is visible. - ----- - .. _class_VisualServer_method_canvas_item_set_z_as_relative_to_parent: - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** @@ -2448,14 +2100,6 @@ Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter` light, :ref:`float` length **)** - -Sets the length of the shadow's gradient. - ----- - .. _class_VisualServer_method_canvas_light_set_shadow_smooth: - void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** @@ -2516,7 +2160,7 @@ Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** +- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** Sets the shape of the occluder polygon. @@ -2524,7 +2168,7 @@ Sets the shape of the occluder polygon. .. _class_VisualServer_method_canvas_occluder_polygon_set_shape_as_lines: -- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** +- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape **)** Sets the shape of the occluder polygon as lines. @@ -2558,14 +2202,6 @@ To place in a scene, attach this directional light to an instance using :ref:`in ---- -.. _class_VisualServer_method_draw: - -- void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** - -Draws a frame. *This method is deprecated*, please use :ref:`force_draw` instead. - ----- - .. _class_VisualServer_method_environment_create: - :ref:`RID` **environment_create** **(** **)** @@ -2586,9 +2222,7 @@ Sets the values to be used with the "Adjustment" post-process effect. See :ref:` .. _class_VisualServer_method_environment_set_ambient_light: -- void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** - -Sets the ambient light parameters. See :ref:`Environment` for more details. +- void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0, :ref:`Color` ao_color=Color( 0, 0, 0, 1 ) **)** ---- @@ -2624,22 +2258,6 @@ Sets the maximum layer to use if using Canvas background mode. ---- -.. _class_VisualServer_method_environment_set_dof_blur_far: - -- void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** - -Sets the values to be used with the "DoF Far Blur" post-process effect. See :ref:`Environment` for more details. - ----- - -.. _class_VisualServer_method_environment_set_dof_blur_near: - -- void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** - -Sets the values to be used with the "DoF Near Blur" post-process effect. See :ref:`Environment` for more details. - ----- - .. _class_VisualServer_method_environment_set_fog: - void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** @@ -2666,9 +2284,7 @@ Sets the variables to be used with the fog height effect. See :ref:`Environment< .. _class_VisualServer_method_environment_set_glow: -- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** - -Sets the variables to be used with the "glow" post-process effect. See :ref:`Environment` for more details. +- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`bool` bicubic_upscale **)** ---- @@ -2676,7 +2292,7 @@ Sets the variables to be used with the "glow" post-process effect. See :ref:`Env - void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** -Sets the :ref:`Sky` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.background_sky`. +Sets the :ref:`Sky` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky`. ---- @@ -2684,7 +2300,7 @@ Sets the :ref:`Sky` to be used as the environment's background when u - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** -Sets a custom field of view for the background :ref:`Sky`. Equivalent to :ref:`Environment.background_sky_custom_fov`. +Sets a custom field of view for the background :ref:`Sky`. Equivalent to :ref:`Environment.sky_custom_fov`. ---- @@ -2692,15 +2308,13 @@ Sets a custom field of view for the background :ref:`Sky`. Equivalent - void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** -Sets the rotation of the background :ref:`Sky` expressed as a :ref:`Basis`. Equivalent to :ref:`Environment.background_sky_orientation`. +Sets the rotation of the background :ref:`Sky` expressed as a :ref:`Basis`. Equivalent to :ref:`Environment.sky_rotation`, where the rotation vector is used to construct the :ref:`Basis`. ---- .. _class_VisualServer_method_environment_set_ssao: -- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** - -Sets the variables to be used with the "Screen Space Ambient Occlusion (SSAO)" post-process effect. See :ref:`Environment` for more details. +- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** ---- @@ -2804,199 +2418,11 @@ Returns the id of a white texture. Creates one if none exists. ---- -.. _class_VisualServer_method_gi_probe_create: - -- :ref:`RID` **gi_probe_create** **(** **)** - -Creates a GI probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``gi_probe_*`` VisualServer functions. - -Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid` static method. - -To place in a scene, attach this GI probe to an instance using :ref:`instance_set_base` using the returned RID. - ----- - -.. _class_VisualServer_method_gi_probe_get_bias: - -- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const - -Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to :ref:`GIProbeData.bias`. - ----- - -.. _class_VisualServer_method_gi_probe_get_bounds: - -- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const - -Returns the axis-aligned bounding box that covers the full extent of the GI probe. - ----- - -.. _class_VisualServer_method_gi_probe_get_cell_size: - -- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const - -Returns the cell size set by :ref:`gi_probe_set_cell_size`. - ----- - -.. _class_VisualServer_method_gi_probe_get_dynamic_data: - -- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const - -Returns the data used by the GI probe. - ----- - -.. _class_VisualServer_method_gi_probe_get_dynamic_range: - -- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const - -Returns the dynamic range set for this GI probe. Equivalent to :ref:`GIProbe.dynamic_range`. - ----- - -.. _class_VisualServer_method_gi_probe_get_energy: - -- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const - -Returns the energy multiplier for this GI probe. Equivalent to :ref:`GIProbe.energy`. - ----- - -.. _class_VisualServer_method_gi_probe_get_normal_bias: - -- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const - -Returns the normal bias for this GI probe. Equivalent to :ref:`GIProbe.normal_bias`. - ----- - -.. _class_VisualServer_method_gi_probe_get_propagation: - -- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const - -Returns the propagation value for this GI probe. Equivalent to :ref:`GIProbe.propagation`. - ----- - -.. _class_VisualServer_method_gi_probe_get_to_cell_xform: - -- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const - -Returns the Transform set by :ref:`gi_probe_set_to_cell_xform`. - ----- - -.. _class_VisualServer_method_gi_probe_is_compressed: - -- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const - -Returns ``true`` if the GI probe data associated with this GI probe is compressed. Equivalent to :ref:`GIProbe.compress`. - ----- - -.. _class_VisualServer_method_gi_probe_is_interior: - -- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const - -Returns ``true`` if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to :ref:`GIProbe.interior`. - ----- - -.. _class_VisualServer_method_gi_probe_set_bias: - -- void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** - -Sets the bias value to avoid self-occlusion. Equivalent to :ref:`GIProbe.bias`. - ----- - -.. _class_VisualServer_method_gi_probe_set_bounds: - -- void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** - -Sets the axis-aligned bounding box that covers the extent of the GI probe. - ----- - -.. _class_VisualServer_method_gi_probe_set_cell_size: - -- void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** - -Sets the size of individual cells within the GI probe. - ----- - -.. _class_VisualServer_method_gi_probe_set_compress: - -- void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** - -Sets the compression setting for the GI probe data. Compressed data will take up less space but may look worse. Equivalent to :ref:`GIProbe.compress`. - ----- - -.. _class_VisualServer_method_gi_probe_set_dynamic_data: - -- void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** - -Sets the data to be used in the GI probe for lighting calculations. Normally this is created and called internally within the :ref:`GIProbe` node. You should not try to set this yourself. - ----- - -.. _class_VisualServer_method_gi_probe_set_dynamic_range: - -- void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** - -Sets the dynamic range of the GI probe. Dynamic range sets the limit for how bright lights can be. A smaller range captures greater detail but limits how bright lights can be. Equivalent to :ref:`GIProbe.dynamic_range`. - ----- - -.. _class_VisualServer_method_gi_probe_set_energy: - -- void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** - -Sets the energy multiplier for this GI probe. A higher energy makes the indirect light from the GI probe brighter. Equivalent to :ref:`GIProbe.energy`. - ----- - -.. _class_VisualServer_method_gi_probe_set_interior: - -- void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** - -Sets the interior value of this GI probe. A GI probe set to interior does not include the sky when calculating lighting. Equivalent to :ref:`GIProbe.interior`. - ----- - -.. _class_VisualServer_method_gi_probe_set_normal_bias: - -- void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** - -Sets the normal bias for this GI probe. Normal bias behaves similar to the other form of bias and may help reduce self-occlusion. Equivalent to :ref:`GIProbe.normal_bias`. - ----- - -.. _class_VisualServer_method_gi_probe_set_propagation: - -- void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** - -Sets the propagation of light within this GI probe. Equivalent to :ref:`GIProbe.propagation`. - ----- - -.. _class_VisualServer_method_gi_probe_set_to_cell_xform: - -- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** - -Sets the to cell :ref:`Transform` for this GI probe. - ----- - .. _class_VisualServer_method_has_changed: - :ref:`bool` **has_changed** **(** **)** const -Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. +Returns ``true`` if changes have been made to the VisualServer's data. :ref:`force_draw` is usually called if this happens. ---- @@ -3352,14 +2778,6 @@ Sets the shadow mode for this directional light. Equivalent to :ref:`Directional ---- -.. _class_VisualServer_method_light_omni_set_shadow_detail: - -- void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** - -Sets whether to use vertical or horizontal detail for this omni light. This can be used to alleviate artifacts in the shadow map. Equivalent to :ref:`OmniLight.omni_shadow_detail`. - ----- - .. _class_VisualServer_method_light_omni_set_shadow_mode: - void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** @@ -3470,7 +2888,7 @@ Returns the energy multiplier used by the lightmap capture. .. _class_VisualServer_method_lightmap_capture_get_octree: -- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const +- :ref:`PackedByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const Returns the octree used by the lightmap capture. @@ -3496,7 +2914,7 @@ Returns the cell transform for this lightmap capture's octree. - void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** -Sets the size of the area covered by the lightmap capture. Equivalent to :ref:`BakedLightmapData.bounds`. +Sets the size of the area covered by the lightmap capture. ---- @@ -3504,15 +2922,15 @@ Sets the size of the area covered by the lightmap capture. Equivalent to :ref:`B - void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** -Sets the energy multiplier for this lightmap capture. Equivalent to :ref:`BakedLightmapData.energy`. +Sets the energy multiplier for this lightmap capture. ---- .. _class_VisualServer_method_lightmap_capture_set_octree: -- void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** +- void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PackedByteArray` octree **)** -Sets the octree to be used by this lightmap capture. This function is normally used by the :ref:`BakedLightmap` node. Equivalent to :ref:`BakedLightmapData.octree`. +Sets the octree to be used by this lightmap capture. ---- @@ -3520,7 +2938,7 @@ Sets the octree to be used by this lightmap capture. This function is normally u - void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** -Sets the subdivision level of this lightmap capture's octree. Equivalent to :ref:`BakedLightmapData.cell_subdiv`. +Sets the subdivision level of this lightmap capture's octree. ---- @@ -3528,7 +2946,7 @@ Sets the subdivision level of this lightmap capture's octree. Equivalent to :ref - void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** -Sets the octree cell transform for this lightmap capture's octree. Equivalent to :ref:`BakedLightmapData.cell_space_transform`. +Sets the octree cell transform for this lightmap capture's octree. ---- @@ -3552,36 +2970,12 @@ Once finished with your RID, you will want to free the RID using the VisualServe .. _class_VisualServer_method_material_get_param: -- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const +- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`StringName` parameter **)** const Returns the value of a certain material's parameter. ---- -.. _class_VisualServer_method_material_get_param_default: - -- :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** const - -Returns the default value for the param if available. Otherwise returns an empty :ref:`Variant`. - ----- - -.. _class_VisualServer_method_material_get_shader: - -- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const - -Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. - ----- - -.. _class_VisualServer_method_material_set_line_width: - -- void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** - -Sets a material's line width. - ----- - .. _class_VisualServer_method_material_set_next_pass: - void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** @@ -3592,7 +2986,7 @@ Sets an object's next material. .. _class_VisualServer_method_material_set_param: -- void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** +- void **material_set_param** **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** Sets a material's parameter. @@ -3616,9 +3010,7 @@ Sets a shader material's shader. .. _class_VisualServer_method_mesh_add_surface_from_arrays: -- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** - -Adds a surface generated from the Arrays to a mesh. See :ref:`PrimitiveType` constants for types. +- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`Dictionary` lods={ }, :ref:`int` compress_format=31744 **)** ---- @@ -3674,22 +3066,6 @@ Returns a mesh's number of surfaces. ---- -.. _class_VisualServer_method_mesh_remove_surface: - -- void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** - -Removes a mesh's surface. - ----- - -.. _class_VisualServer_method_mesh_set_blend_shape_count: - -- void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** - -Sets a mesh's blend shape count. - ----- - .. _class_VisualServer_method_mesh_set_blend_shape_mode: - void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** @@ -3706,38 +3082,6 @@ Sets a mesh's custom aabb. ---- -.. _class_VisualServer_method_mesh_surface_get_aabb: - -- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns a mesh's surface's aabb. - ----- - -.. _class_VisualServer_method_mesh_surface_get_array: - -- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns a mesh's surface's vertex buffer. - ----- - -.. _class_VisualServer_method_mesh_surface_get_array_index_len: - -- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns a mesh's surface's amount of indices. - ----- - -.. _class_VisualServer_method_mesh_surface_get_array_len: - -- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns a mesh's surface's amount of vertices. - ----- - .. _class_VisualServer_method_mesh_surface_get_arrays: - :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const @@ -3754,14 +3098,6 @@ Returns a mesh's surface's arrays for blend shapes. ---- -.. _class_VisualServer_method_mesh_surface_get_format: - -- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns the format of a mesh's surface. - ----- - .. _class_VisualServer_method_mesh_surface_get_format_offset: - :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const @@ -3778,14 +3114,6 @@ Function is unused in Godot 3.x. ---- -.. _class_VisualServer_method_mesh_surface_get_index_array: - -- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns a mesh's surface's index buffer. - ----- - .. _class_VisualServer_method_mesh_surface_get_material: - :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const @@ -3794,22 +3122,6 @@ Returns a mesh's surface's material. ---- -.. _class_VisualServer_method_mesh_surface_get_primitive_type: - -- :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns the primitive type of a mesh's surface. - ----- - -.. _class_VisualServer_method_mesh_surface_get_skeleton_aabb: - -- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const - -Returns the aabb of a mesh's surface's skeleton. - ----- - .. _class_VisualServer_method_mesh_surface_set_material: - void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** @@ -3820,7 +3132,7 @@ Sets a mesh's surface's material. .. _class_VisualServer_method_mesh_surface_update_region: -- void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** +- void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh. @@ -3828,9 +3140,7 @@ Updates a specific region of a vertex buffer for the specified surface. Warning: .. _class_VisualServer_method_multimesh_allocate: -- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** - -Allocates space for the multimesh data. Format parameters determine how the data will be stored by OpenGL. See :ref:`MultimeshTransformFormat`, :ref:`MultimeshColorFormat`, and :ref:`MultimeshCustomDataFormat` for usage. Equivalent to :ref:`MultiMesh.instance_count`. +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** ---- @@ -3854,6 +3164,12 @@ Calculates and returns the axis-aligned bounding box that encloses all instances ---- +.. _class_VisualServer_method_multimesh_get_buffer: + +- :ref:`PackedFloat32Array` **multimesh_get_buffer** **(** :ref:`RID` multimesh **)** const + +---- + .. _class_VisualServer_method_multimesh_get_instance_count: - :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const @@ -3942,19 +3258,9 @@ Sets the :ref:`Transform2D` for this instance. For use when m ---- -.. _class_VisualServer_method_multimesh_set_as_bulk_array: +.. _class_VisualServer_method_multimesh_set_buffer: -- void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** - -Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. - - - -All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc. - - - -:ref:`Transform` is stored as 12 floats, :ref:`Transform2D` is stored as 8 floats, ``COLOR_8BIT`` / ``CUSTOM_DATA_8BIT`` is stored as 1 float (4 bytes as is) and ``COLOR_FLOAT`` / ``CUSTOM_DATA_FLOAT`` is stored as 4 floats. +- void **multimesh_set_buffer** **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** ---- @@ -4284,7 +3590,7 @@ Sets how often the reflection probe updates. Can either be once or every frame. .. _class_VisualServer_method_request_frame_drawn_callback: -- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** +- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`StringName` method, :ref:`Variant` userdata **)** Schedules a callback to the corresponding named ``method`` on ``where`` after a frame has been drawn. @@ -4328,14 +3634,6 @@ Sets the fallback environment to be used by this scenario. The fallback environm ---- -.. _class_VisualServer_method_scenario_set_reflection_atlas_size: - -- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** - -Sets the size of the reflection atlas shared by all reflection probes in this scenario. - ----- - .. _class_VisualServer_method_set_boot_image: - void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** @@ -4380,12 +3678,18 @@ Returns a shader's code. .. _class_VisualServer_method_shader_get_default_texture_param: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const +- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` name **)** const Returns a default texture from a shader searched by name. ---- +.. _class_VisualServer_method_shader_get_param_default: + +- :ref:`Variant` **shader_get_param_default** **(** :ref:`RID` material, :ref:`StringName` parameter **)** const + +---- + .. _class_VisualServer_method_shader_get_param_list: - :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const @@ -4404,7 +3708,7 @@ Sets a shader's code. .. _class_VisualServer_method_shader_set_default_texture_param: -- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** +- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture **)** Sets a shader's default texture. Overwrites the texture given by name. @@ -4480,9 +3784,7 @@ Once finished with your RID, you will want to free the RID using the VisualServe .. _class_VisualServer_method_sky_set_texture: -- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** - -Sets a sky's texture. +- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` panorama **)** ---- @@ -4498,181 +3800,15 @@ To place in a scene, attach this spot light to an instance using :ref:`instance_ ---- -.. _class_VisualServer_method_sync: +.. _class_VisualServer_method_texture_2d_create: -- void **sync** **(** **)** - -Not implemented in Godot 3.x. +- :ref:`RID` **texture_2d_create** **(** :ref:`Image` image **)** ---- -.. _class_VisualServer_method_texture_allocate: +.. _class_VisualServer_method_texture_2d_get: -- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** - -Allocates the GPU memory for the texture. - ----- - -.. _class_VisualServer_method_texture_bind: - -- void **texture_bind** **(** :ref:`RID` texture, :ref:`int` number **)** - -Binds the texture to a texture slot. - ----- - -.. _class_VisualServer_method_texture_create: - -- :ref:`RID` **texture_create** **(** **)** - -Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_*`` VisualServer functions. - -Once finished with your RID, you will want to free the RID using the VisualServer's :ref:`free_rid` static method. - ----- - -.. _class_VisualServer_method_texture_create_from_image: - -- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** - -Creates a texture, allocates the space for an image, and fills in the image. - ----- - -.. _class_VisualServer_method_texture_debug_usage: - -- :ref:`Array` **texture_debug_usage** **(** **)** - -Returns a list of all the textures and their information. - ----- - -.. _class_VisualServer_method_texture_get_data: - -- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const - -Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. - ----- - -.. _class_VisualServer_method_texture_get_depth: - -- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const - -Returns the depth of the texture. - ----- - -.. _class_VisualServer_method_texture_get_flags: - -- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const - -Returns the flags of a texture. - ----- - -.. _class_VisualServer_method_texture_get_format: - -- :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const - -Returns the format of the texture's image. - ----- - -.. _class_VisualServer_method_texture_get_height: - -- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const - -Returns the texture's height. - ----- - -.. _class_VisualServer_method_texture_get_path: - -- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const - -Returns the texture's path. - ----- - -.. _class_VisualServer_method_texture_get_texid: - -- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const - -Returns the opengl id of the texture's image. - ----- - -.. _class_VisualServer_method_texture_get_type: - -- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const - -Returns the type of the texture, can be any of the :ref:`TextureType`. - ----- - -.. _class_VisualServer_method_texture_get_width: - -- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const - -Returns the texture's width. - ----- - -.. _class_VisualServer_method_texture_set_data: - -- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** - -Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. - ----- - -.. _class_VisualServer_method_texture_set_data_partial: - -- void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** - -Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly. - ----- - -.. _class_VisualServer_method_texture_set_flags: - -- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** - -Sets the texture's flags. See :ref:`TextureFlags` for options. - ----- - -.. _class_VisualServer_method_texture_set_path: - -- void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** - -Sets the texture's path. - ----- - -.. _class_VisualServer_method_texture_set_shrink_all_x2_on_set_data: - -- void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** - -If ``true``, sets internal processes to shrink all image data to half the size. - ----- - -.. _class_VisualServer_method_texture_set_size_override: - -- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** - -Resizes the texture to the specified dimensions. - ----- - -.. _class_VisualServer_method_textures_keep_original: - -- void **textures_keep_original** **(** :ref:`bool` enable **)** - -If ``true``, the image will be stored in the texture's images array if overwritten. +- :ref:`Image` **texture_2d_get** **(** :ref:`RID` texture **)** const ---- @@ -4794,14 +3930,6 @@ Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` viewport, :ref:`bool` disabled **)** - -If ``true``, a viewport's 3D rendering is disabled. - ----- - .. _class_VisualServer_method_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** @@ -4818,14 +3946,6 @@ Sets the viewport's global transformation matrix. ---- -.. _class_VisualServer_method_viewport_set_hdr: - -- void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** - -If ``true``, the viewport renders to hdr. - ----- - .. _class_VisualServer_method_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** @@ -4916,25 +4036,9 @@ Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` viewport, :ref:`ViewportUsage` usage **)** - -Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. - ----- - .. _class_VisualServer_method_viewport_set_use_arvr: - void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. ----- - -.. _class_VisualServer_method_viewport_set_vflip: - -- void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** - -If ``true``, the viewport's rendering is flipped vertically. - diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 25c3ef288..8f17576c8 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -28,6 +28,8 @@ Properties +-------------------------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`graph_offset` | ``Vector2( 0, 0 )`` | +-------------------------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`version` | ``""`` | ++-------------------------------+---------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Methods ------- @@ -47,7 +49,7 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** const | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | +| :ref:`PackedInt32Array` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** const | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,11 +79,11 @@ Enumerations enum **Type**: -- **TYPE_VERTEX** = **0** +- **TYPE_VERTEX** = **0** --- A vertex shader, operating on vertices. -- **TYPE_FRAGMENT** = **1** +- **TYPE_FRAGMENT** = **1** --- A fragment shader, operating on fragments (pixels). -- **TYPE_LIGHT** = **2** +- **TYPE_LIGHT** = **2** --- A shader for light calculations. - **TYPE_MAX** = **3** --- Represents the size of the :ref:`Type` enum. @@ -111,6 +113,22 @@ Property Descriptions | *Getter* | get_graph_offset() | +-----------+-------------------------+ +The offset vector of the whole graph. + +---- + +.. _class_VisualShader_property_version: + +- :ref:`String` **version** + ++-----------+--------------------+ +| *Default* | ``""`` | ++-----------+--------------------+ +| *Setter* | set_version(value) | ++-----------+--------------------+ +| *Getter* | get_version() | ++-----------+--------------------+ + Method Descriptions ------------------- @@ -118,47 +136,63 @@ Method Descriptions - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** +Adds the specified node to the shader. + ---- .. _class_VisualShader_method_can_connect_nodes: - :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +Returns ``true`` if the specified nodes and ports can be connected together. + ---- .. _class_VisualShader_method_connect_nodes: - :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +Connects the specified nodes and ports. + ---- .. _class_VisualShader_method_connect_nodes_forced: - void **connect_nodes_forced** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. + ---- .. _class_VisualShader_method_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +Connects the specified nodes and ports. + ---- .. _class_VisualShader_method_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const +Returns the shader node instance with specified ``type`` and ``id``. + ---- .. _class_VisualShader_method_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const +Returns the list of connected nodes with the specified type. + ---- .. _class_VisualShader_method_get_node_list: -- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const +- :ref:`PackedInt32Array` **get_node_list** **(** :ref:`Type` type **)** const + +Returns the list of all nodes in the shader with the specified type. ---- @@ -166,6 +200,8 @@ Method Descriptions - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const +Returns the position of the specified node within the shader graph. + ---- .. _class_VisualShader_method_get_valid_node_id: @@ -178,21 +214,29 @@ Method Descriptions - :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +Returns ``true`` if the specified node and port connection exist. + ---- .. _class_VisualShader_method_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** +Removes the specified node from the shader. + ---- .. _class_VisualShader_method_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** +Sets the mode of this shader. + ---- .. _class_VisualShader_method_set_node_position: - void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** +Sets the position of the specified node. + diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 66bca6c00..f3c0fdbc3 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -11,9 +11,9 @@ VisualShaderNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeBooleanConstant`, :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFaceForward`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeGroupBase`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarClamp`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarDerivativeFunc`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeScalarSmoothStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorClamp`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorDerivativeFunc`, :ref:`VisualShaderNodeVectorDistance`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorRefract`, :ref:`VisualShaderNodeVectorScalarMix`, :ref:`VisualShaderNodeVectorScalarSmoothStep`, :ref:`VisualShaderNodeVectorScalarStep`, :ref:`VisualShaderNodeVectorSmoothStep` - +**Inherited By:** :ref:`VisualShaderNodeBooleanConstant`, :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeCubemap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFaceForward`, :ref:`VisualShaderNodeFloatConstant`, :ref:`VisualShaderNodeFloatFunc`, :ref:`VisualShaderNodeFloatOp`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeGroupBase`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIntConstant`, :ref:`VisualShaderNodeIntFunc`, :ref:`VisualShaderNodeIntOp`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarClamp`, :ref:`VisualShaderNodeScalarDerivativeFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarSmoothStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorClamp`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorDerivativeFunc`, :ref:`VisualShaderNodeVectorDistance`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorRefract`, :ref:`VisualShaderNodeVectorScalarMix`, :ref:`VisualShaderNodeVectorScalarSmoothStep`, :ref:`VisualShaderNodeVectorScalarStep`, :ref:`VisualShaderNodeVectorSmoothStep` +Base class for nodes in a visual shader graph. Tutorials --------- @@ -47,7 +47,7 @@ Signals - **editor_refresh_request** **(** **)** -Emitted when the node requests an editor refresh. Currently called only in setter of :ref:`VisualShaderNodeTexture.source`, :ref:`VisualShaderNodeTexture`, and :ref:`VisualShaderNodeCubeMap` (and their derivatives). +Emitted when the node requests an editor refresh. Currently called only in setter of :ref:`VisualShaderNodeTexture.source`, :ref:`VisualShaderNodeTexture`, and :ref:`VisualShaderNodeCubemap` (and their derivatives). Enumerations ------------ @@ -56,6 +56,8 @@ Enumerations .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR: +.. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR_INT: + .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR: .. _class_VisualShaderNode_constant_PORT_TYPE_BOOLEAN: @@ -70,15 +72,17 @@ enum **PortType**: - **PORT_TYPE_SCALAR** = **0** --- Floating-point scalar. Translated to ``float`` type in shader code. -- **PORT_TYPE_VECTOR** = **1** --- 3D vector of floating-point values. Translated to ``vec3`` type in shader code. +- **PORT_TYPE_SCALAR_INT** = **1** --- Integer scalar. Translated to ``int`` type in shader code. -- **PORT_TYPE_BOOLEAN** = **2** --- Boolean type. Translated to ``bool`` type in shader code. +- **PORT_TYPE_VECTOR** = **2** --- 3D vector of floating-point values. Translated to ``vec3`` type in shader code. -- **PORT_TYPE_TRANSFORM** = **3** --- Transform type. Translated to ``mat4`` type in shader code. +- **PORT_TYPE_BOOLEAN** = **3** --- Boolean type. Translated to ``bool`` type in shader code. -- **PORT_TYPE_SAMPLER** = **4** --- Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes. +- **PORT_TYPE_TRANSFORM** = **4** --- Transform type. Translated to ``mat4`` type in shader code. -- **PORT_TYPE_MAX** = **5** --- Represents the size of the :ref:`PortType` enum. +- **PORT_TYPE_SAMPLER** = **5** --- Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes. + +- **PORT_TYPE_MAX** = **6** --- Represents the size of the :ref:`PortType` enum. Property Descriptions --------------------- diff --git a/classes/class_visualshadernodecompare.rst b/classes/class_visualshadernodecompare.rst index eaf88aebd..73efacdc3 100644 --- a/classes/class_visualshadernodecompare.rst +++ b/classes/class_visualshadernodecompare.rst @@ -36,6 +36,8 @@ Enumerations .. _class_VisualShaderNodeCompare_constant_CTYPE_SCALAR: +.. _class_VisualShaderNodeCompare_constant_CTYPE_SCALAR_INT: + .. _class_VisualShaderNodeCompare_constant_CTYPE_VECTOR: .. _class_VisualShaderNodeCompare_constant_CTYPE_BOOLEAN: @@ -46,11 +48,13 @@ enum **ComparisonType**: - **CTYPE_SCALAR** = **0** --- A floating-point scalar. -- **CTYPE_VECTOR** = **1** --- A 3D vector type. +- **CTYPE_SCALAR_INT** = **1** --- An integer scalar. -- **CTYPE_BOOLEAN** = **2** --- A boolean type. +- **CTYPE_VECTOR** = **2** --- A 3D vector type. -- **CTYPE_TRANSFORM** = **3** --- A transform (``mat4``) type. +- **CTYPE_BOOLEAN** = **3** --- A boolean type. + +- **CTYPE_TRANSFORM** = **4** --- A transform (``mat4``) type. ---- @@ -80,7 +84,7 @@ enum **Function**: - **FUNC_LESS_THAN** = **4** --- Comparison for less than (``a < b``). Cannot be used if :ref:`type` set to :ref:`CTYPE_BOOLEAN` or :ref:`CTYPE_TRANSFORM`. -- **FUNC_LESS_THAN_EQUAL** = **5** --- Comparison for less than or equal (``a < b``). Cannot be used if :ref:`type` set to :ref:`CTYPE_BOOLEAN` or :ref:`CTYPE_TRANSFORM`. +- **FUNC_LESS_THAN_EQUAL** = **5** --- Comparison for less than or equal (``a <= b``). Cannot be used if :ref:`type` set to :ref:`CTYPE_BOOLEAN` or :ref:`CTYPE_TRANSFORM`. ---- diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 52a7d5cfd..91deaff8e 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -1,17 +1,17 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubeMap.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubemap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_VisualShaderNodeCubeMap: +.. _class_VisualShaderNodeCubemap: -VisualShaderNodeCubeMap +VisualShaderNodeCubemap ======================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -A :ref:`CubeMap` sampling node to be used within the visual shader graph. +A :ref:`Cubemap` sampling node to be used within the visual shader graph. Description ----------- @@ -22,37 +22,37 @@ Properties ---------- +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ -| :ref:`CubeMap` | :ref:`cube_map` | | +| :ref:`Cubemap` | :ref:`cube_map` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ -| :ref:`Source` | :ref:`source` | ``0`` | +| :ref:`Source` | :ref:`source` | ``0`` | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ -| :ref:`TextureType` | :ref:`texture_type` | ``0`` | +| :ref:`TextureType` | :ref:`texture_type` | ``0`` | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ Enumerations ------------ -.. _enum_VisualShaderNodeCubeMap_Source: +.. _enum_VisualShaderNodeCubemap_Source: -.. _class_VisualShaderNodeCubeMap_constant_SOURCE_TEXTURE: +.. _class_VisualShaderNodeCubemap_constant_SOURCE_TEXTURE: -.. _class_VisualShaderNodeCubeMap_constant_SOURCE_PORT: +.. _class_VisualShaderNodeCubemap_constant_SOURCE_PORT: enum **Source**: -- **SOURCE_TEXTURE** = **0** --- Use the :ref:`CubeMap` set via :ref:`cube_map`. If this is set to :ref:`source`, the ``samplerCube`` port is ignored. +- **SOURCE_TEXTURE** = **0** --- Use the :ref:`Cubemap` set via :ref:`cube_map`. If this is set to :ref:`source`, the ``samplerCube`` port is ignored. -- **SOURCE_PORT** = **1** --- Use the :ref:`CubeMap` sampler reference passed via the ``samplerCube`` port. If this is set to :ref:`source`, the :ref:`cube_map` texture is ignored. +- **SOURCE_PORT** = **1** --- Use the :ref:`Cubemap` sampler reference passed via the ``samplerCube`` port. If this is set to :ref:`source`, the :ref:`cube_map` texture is ignored. ---- -.. _enum_VisualShaderNodeCubeMap_TextureType: +.. _enum_VisualShaderNodeCubemap_TextureType: -.. _class_VisualShaderNodeCubeMap_constant_TYPE_DATA: +.. _class_VisualShaderNodeCubemap_constant_TYPE_DATA: -.. _class_VisualShaderNodeCubeMap_constant_TYPE_COLOR: +.. _class_VisualShaderNodeCubemap_constant_TYPE_COLOR: -.. _class_VisualShaderNodeCubeMap_constant_TYPE_NORMALMAP: +.. _class_VisualShaderNodeCubemap_constant_TYPE_NORMALMAP: enum **TextureType**: @@ -65,9 +65,9 @@ enum **TextureType**: Property Descriptions --------------------- -.. _class_VisualShaderNodeCubeMap_property_cube_map: +.. _class_VisualShaderNodeCubemap_property_cube_map: -- :ref:`CubeMap` **cube_map** +- :ref:`Cubemap` **cube_map** +----------+---------------------+ | *Setter* | set_cube_map(value) | @@ -75,13 +75,13 @@ Property Descriptions | *Getter* | get_cube_map() | +----------+---------------------+ -The :ref:`CubeMap` texture to sample when using :ref:`SOURCE_TEXTURE` as :ref:`source`. +The :ref:`Cubemap` texture to sample when using :ref:`SOURCE_TEXTURE` as :ref:`source`. ---- -.. _class_VisualShaderNodeCubeMap_property_source: +.. _class_VisualShaderNodeCubemap_property_source: -- :ref:`Source` **source** +- :ref:`Source` **source** +-----------+-------------------+ | *Default* | ``0`` | @@ -91,13 +91,13 @@ The :ref:`CubeMap` texture to sample when using :ref:`SOURCE_TEXT | *Getter* | get_source() | +-----------+-------------------+ -Defines which source should be used for the sampling. See :ref:`Source` for options. +Defines which source should be used for the sampling. See :ref:`Source` for options. ---- -.. _class_VisualShaderNodeCubeMap_property_texture_type: +.. _class_VisualShaderNodeCubemap_property_texture_type: -- :ref:`TextureType` **texture_type** +- :ref:`TextureType` **texture_type** +-----------+-------------------------+ | *Default* | ``0`` | @@ -107,5 +107,5 @@ Defines which source should be used for the sampling. See :ref:`Source` for options. +Defines the type of data provided by the source texture. See :ref:`TextureType` for options. diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index 2cfb0bd6e..bac732e65 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -1,20 +1,20 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubeMapUniform.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeCubemapUniform.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_VisualShaderNodeCubeMapUniform: +.. _class_VisualShaderNodeCubemapUniform: -VisualShaderNodeCubeMapUniform +VisualShaderNodeCubemapUniform ============================== **Inherits:** :ref:`VisualShaderNodeTextureUniform` **<** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -A :ref:`CubeMap` uniform node to be used within the visual shader graph. +A :ref:`Cubemap` uniform node to be used within the visual shader graph. Description ----------- -Translated to ``uniform samplerCube`` in the shader language. The output value can be used as port for :ref:`VisualShaderNodeCubeMap`. +Translated to ``uniform samplerCube`` in the shader language. The output value can be used as port for :ref:`VisualShaderNodeCubemap`. diff --git a/classes/class_visualshadernodecustom.rst b/classes/class_visualshadernodecustom.rst index b3b65887d..3c44eb1e5 100644 --- a/classes/class_visualshadernodecustom.rst +++ b/classes/class_visualshadernodecustom.rst @@ -34,33 +34,33 @@ Tutorials Methods ------- -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_code` **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_description` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_global_code` **(** :ref:`int` mode **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_port_count` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_input_port_type` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_name` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_port_count` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_port_name` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_subcategory` **(** **)** virtual | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_category` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_code` **(** :ref:`Array` input_vars, :ref:`Array` output_vars, :ref:`int` mode, :ref:`int` type **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_description` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_global_code` **(** :ref:`int` mode **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_port_count` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`_get_input_port_name` **(** :ref:`int` port **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_input_port_type` **(** :ref:`int` port **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_name` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_port_count` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`_get_output_port_name` **(** :ref:`int` port **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_output_port_type` **(** :ref:`int` port **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_return_icon_type` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_highend` **(** **)** virtual | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -69,9 +69,9 @@ Method Descriptions - :ref:`String` **_get_category** **(** **)** virtual -Override this method to define the category of the associated custom node in the Visual Shader Editor's members dialog. +Override this method to define the path to the associated custom node in the Visual Shader Editor's members dialog. The path may looks like ``"MyGame/MyFunctions/Noise"``. -Defining this method is **optional**. If not overridden, the node will be filed under the "Custom" category. +Defining this method is **optional**. If not overridden, the node will be filed under the "Addons" category. ---- @@ -127,7 +127,7 @@ Defining this method is **required**. If not overridden, the node has no input p .. _class_VisualShaderNodeCustom_method__get_input_port_name: -- :ref:`String` **_get_input_port_name** **(** :ref:`int` port **)** virtual +- :ref:`StringName` **_get_input_port_name** **(** :ref:`int` port **)** virtual Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the ``input_vars`` array in :ref:`_get_code`. @@ -167,7 +167,7 @@ Defining this method is **required**. If not overridden, the node has no output .. _class_VisualShaderNodeCustom_method__get_output_port_name: -- :ref:`String` **_get_output_port_name** **(** :ref:`int` port **)** virtual +- :ref:`StringName` **_get_output_port_name** **(** :ref:`int` port **)** virtual Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the ``output_vars`` array in :ref:`_get_code`. @@ -195,11 +195,11 @@ Defining this method is **optional**. If not overridden, no return icon is shown ---- -.. _class_VisualShaderNodeCustom_method__get_subcategory: +.. _class_VisualShaderNodeCustom_method__is_highend: -- :ref:`String` **_get_subcategory** **(** **)** virtual +- :ref:`bool` **_is_highend** **(** **)** virtual -Override this method to define the subcategory of the associated custom node in the Visual Shader Editor's members dialog. +Override this method to enable high-end mark in the Visual Shader Editor's members dialog. -Defining this method is **optional**. If not overridden, the node will be filed under the root of the main category (see :ref:`_get_category`). +Defining this method is **optional**. If not overridden, it's false. diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodefloatconstant.rst similarity index 59% rename from classes/class_visualshadernodescalarconstant.rst rename to classes/class_visualshadernodefloatconstant.rst index f3658c43e..9a5c177cb 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodefloatconstant.rst @@ -1,29 +1,34 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarConstant.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatConstant.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_VisualShaderNodeScalarConstant: +.. _class_VisualShaderNodeFloatConstant: -VisualShaderNodeScalarConstant -============================== +VisualShaderNodeFloatConstant +============================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +A scalar floating-point constant to be used within the visual shader graph. +Description +----------- + +Translated to ``float`` in the shader language. Properties ---------- -+---------------------------+-------------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`constant` | ``0.0`` | -+---------------------------+-------------------------------------------------------------------------+---------+ ++---------------------------+------------------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`constant` | ``0.0`` | ++---------------------------+------------------------------------------------------------------------+---------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeScalarConstant_property_constant: +.. _class_VisualShaderNodeFloatConstant_property_constant: - :ref:`float` **constant** @@ -35,3 +40,5 @@ Property Descriptions | *Getter* | get_constant() | +-----------+---------------------+ +A floating-point constant which represents a state of this node. + diff --git a/classes/class_visualshadernodefloatfunc.rst b/classes/class_visualshadernodefloatfunc.rst new file mode 100644 index 000000000..b624183af --- /dev/null +++ b/classes/class_visualshadernodefloatfunc.rst @@ -0,0 +1,179 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeFloatFunc: + +VisualShaderNodeFloatFunc +========================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A scalar floating-point function to be used within the visual shader graph. + +Description +----------- + +Accept a floating-point scalar (``x``) to the input port and transform it according to :ref:`function`. + +Properties +---------- + ++----------------------------------------------------------+--------------------------------------------------------------------+--------+ +| :ref:`Function` | :ref:`function` | ``13`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeFloatFunc_Function: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COS: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TAN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASIN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOS: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATAN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SINH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_COSH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TANH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SQRT: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ABS: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SIGN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FLOOR: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUND: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_CEIL: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_FRAC: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_SATURATE: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_NEGATE: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ACOSH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ASINH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ATANH: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_DEGREES: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_EXP2: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_INVERSE_SQRT: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_LOG2: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RADIANS: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_RECIPROCAL: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ROUNDEVEN: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_TRUNC: + +.. _class_VisualShaderNodeFloatFunc_constant_FUNC_ONEMINUS: + +enum **Function**: + +- **FUNC_SIN** = **0** --- Returns the sine of the parameter. Translates to ``sin(x)`` in the Godot Shader Language. + +- **FUNC_COS** = **1** --- Returns the cosine of the parameter. Translates to ``cos(x)`` in the Godot Shader Language. + +- **FUNC_TAN** = **2** --- Returns the tangent of the parameter. Translates to ``tan(x)`` in the Godot Shader Language. + +- **FUNC_ASIN** = **3** --- Returns the arc-sine of the parameter. Translates to ``asin(x)`` in the Godot Shader Language. + +- **FUNC_ACOS** = **4** --- Returns the arc-cosine of the parameter. Translates to ``acos(x)`` in the Godot Shader Language. + +- **FUNC_ATAN** = **5** --- Returns the arc-tangent of the parameter. Translates to ``atan(x)`` in the Godot Shader Language. + +- **FUNC_SINH** = **6** --- Returns the hyperbolic sine of the parameter. Translates to ``sinh(x)`` in the Godot Shader Language. + +- **FUNC_COSH** = **7** --- Returns the hyperbolic cosine of the parameter. Translates to ``cosh(x)`` in the Godot Shader Language. + +- **FUNC_TANH** = **8** --- Returns the hyperbolic tangent of the parameter. Translates to ``tanh(x)`` in the Godot Shader Language. + +- **FUNC_LOG** = **9** --- Returns the natural logarithm of the parameter. Translates to ``log(x)`` in the Godot Shader Language. + +- **FUNC_EXP** = **10** --- Returns the natural exponentiation of the parameter. Translates to ``exp(x)`` in the Godot Shader Language. + +- **FUNC_SQRT** = **11** --- Returns the square root of the parameter. Translates to ``sqrt(x)`` in the Godot Shader Language. + +- **FUNC_ABS** = **12** --- Returns the absolute value of the parameter. Translates to ``abs(x)`` in the Godot Shader Language. + +- **FUNC_SIGN** = **13** --- Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language. + +- **FUNC_FLOOR** = **14** --- Finds the nearest integer less than or equal to the parameter. Translates to ``floor(x)`` in the Godot Shader Language. + +- **FUNC_ROUND** = **15** --- Finds the nearest integer to the parameter. Translates to ``round(x)`` in the Godot Shader Language. + +- **FUNC_CEIL** = **16** --- Finds the nearest integer that is greater than or equal to the parameter. Translates to ``ceil(x)`` in the Godot Shader Language. + +- **FUNC_FRAC** = **17** --- Computes the fractional part of the argument. Translates to ``fract(x)`` in the Godot Shader Language. + +- **FUNC_SATURATE** = **18** --- Clamps the value between ``0.0`` and ``1.0`` using ``min(max(x, 0.0), 1.0)``. + +- **FUNC_NEGATE** = **19** --- Negates the ``x`` using ``-(x)``. + +- **FUNC_ACOSH** = **20** --- Returns the arc-hyperbolic-cosine of the parameter. Translates to ``acosh(x)`` in the Godot Shader Language. + +- **FUNC_ASINH** = **21** --- Returns the arc-hyperbolic-sine of the parameter. Translates to ``asinh(x)`` in the Godot Shader Language. + +- **FUNC_ATANH** = **22** --- Returns the arc-hyperbolic-tangent of the parameter. Translates to ``atanh(x)`` in the Godot Shader Language. + +- **FUNC_DEGREES** = **23** --- Convert a quantity in radians to degrees. Translates to ``degrees(x)`` in the Godot Shader Language. + +- **FUNC_EXP2** = **24** --- Returns 2 raised by the power of the parameter. Translates to ``exp2(x)`` in the Godot Shader Language. + +- **FUNC_INVERSE_SQRT** = **25** --- Returns the inverse of the square root of the parameter. Translates to ``inversesqrt(x)`` in the Godot Shader Language. + +- **FUNC_LOG2** = **26** --- Returns the base 2 logarithm of the parameter. Translates to ``log2(x)`` in the Godot Shader Language. + +- **FUNC_RADIANS** = **27** --- Convert a quantity in degrees to radians. Translates to ``radians(x)`` in the Godot Shader Language. + +- **FUNC_RECIPROCAL** = **28** --- Finds reciprocal value of dividing 1 by ``x`` (i.e. ``1 / x``). + +- **FUNC_ROUNDEVEN** = **29** --- Finds the nearest even integer to the parameter. Translates to ``roundEven(x)`` in the Godot Shader Language. + +- **FUNC_TRUNC** = **30** --- Returns a value equal to the nearest integer to ``x`` whose absolute value is not larger than the absolute value of ``x``. Translates to ``trunc(x)`` in the Godot Shader Language. + +- **FUNC_ONEMINUS** = **31** --- Subtracts scalar ``x`` from 1 (i.e. ``1 - x``). + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeFloatFunc_property_function: + +- :ref:`Function` **function** + ++-----------+---------------------+ +| *Default* | ``13`` | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ + +A function to be applied to the scalar. See :ref:`Function` for options. + diff --git a/classes/class_visualshadernodefloatop.rst b/classes/class_visualshadernodefloatop.rst new file mode 100644 index 000000000..43db82d60 --- /dev/null +++ b/classes/class_visualshadernodefloatop.rst @@ -0,0 +1,91 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatOp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeFloatOp: + +VisualShaderNodeFloatOp +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A floating-point scalar operator to be used within the visual shader graph. + +Description +----------- + +Applies :ref:`operator` to two floating-point inputs: ``a`` and ``b``. + +Properties +---------- + ++--------------------------------------------------------+------------------------------------------------------------------+-------+ +| :ref:`Operator` | :ref:`operator` | ``0`` | ++--------------------------------------------------------+------------------------------------------------------------------+-------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeFloatOp_Operator: + +.. _class_VisualShaderNodeFloatOp_constant_OP_ADD: + +.. _class_VisualShaderNodeFloatOp_constant_OP_SUB: + +.. _class_VisualShaderNodeFloatOp_constant_OP_MUL: + +.. _class_VisualShaderNodeFloatOp_constant_OP_DIV: + +.. _class_VisualShaderNodeFloatOp_constant_OP_MOD: + +.. _class_VisualShaderNodeFloatOp_constant_OP_POW: + +.. _class_VisualShaderNodeFloatOp_constant_OP_MAX: + +.. _class_VisualShaderNodeFloatOp_constant_OP_MIN: + +.. _class_VisualShaderNodeFloatOp_constant_OP_ATAN2: + +.. _class_VisualShaderNodeFloatOp_constant_OP_STEP: + +enum **Operator**: + +- **OP_ADD** = **0** --- Sums two numbers using ``a + b``. + +- **OP_SUB** = **1** --- Subtracts two numbers using ``a - b``. + +- **OP_MUL** = **2** --- Multiplies two numbers using ``a * b``. + +- **OP_DIV** = **3** --- Divides two numbers using ``a / b``. + +- **OP_MOD** = **4** --- Calculates the remainder of two numbers. Translates to ``mod(a, b)`` in the Godot Shader Language. + +- **OP_POW** = **5** --- Raises the ``a`` to the power of ``b``. Translates to ``pow(a, b)`` in the Godot Shader Language. + +- **OP_MAX** = **6** --- Returns the greater of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language. + +- **OP_MIN** = **7** --- Returns the lesser of two numbers. Translates to ``min(a, b)`` in the Godot Shader Language. + +- **OP_ATAN2** = **8** --- Returns the arc-tangent of the parameters. Translates to ``atan(a, b)`` in the Godot Shader Language. + +- **OP_STEP** = **9** --- Generates a step function by comparing ``b``\ (x) to ``a``\ (edge). Returns 0.0 if ``x`` is smaller than ``edge`` and otherwise 1.0. Translates to ``step(a, b)`` in the Godot Shader Language. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeFloatOp_property_operator: + +- :ref:`Operator` **operator** + ++-----------+---------------------+ +| *Default* | ``0`` | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ + +An operator to be applied to the inputs. See :ref:`Operator` for options. + diff --git a/classes/class_visualshadernodefloatuniform.rst b/classes/class_visualshadernodefloatuniform.rst new file mode 100644 index 000000000..583dadf17 --- /dev/null +++ b/classes/class_visualshadernodefloatuniform.rst @@ -0,0 +1,117 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFloatUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeFloatUniform: + +VisualShaderNodeFloatUniform +============================ + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A scalar float uniform to be used within the visual shader graph. + +Description +----------- + +Translated to ``uniform float`` in the shader language. + +Properties +---------- + ++-----------------------------------------------------+---------------------------------------------------------------+---------+ +| :ref:`Hint` | :ref:`hint` | ``0`` | ++-----------------------------------------------------+---------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`max` | ``1.0`` | ++-----------------------------------------------------+---------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`min` | ``0.0`` | ++-----------------------------------------------------+---------------------------------------------------------------+---------+ +| :ref:`float` | :ref:`step` | ``0.1`` | ++-----------------------------------------------------+---------------------------------------------------------------+---------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeFloatUniform_Hint: + +.. _class_VisualShaderNodeFloatUniform_constant_HINT_NONE: + +.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE: + +.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP: + +enum **Hint**: + +- **HINT_NONE** = **0** --- No hint used. + +- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. + +- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeFloatUniform_property_hint: + +- :ref:`Hint` **hint** + ++-----------+-----------------+ +| *Default* | ``0`` | ++-----------+-----------------+ +| *Setter* | set_hint(value) | ++-----------+-----------------+ +| *Getter* | get_hint() | ++-----------+-----------------+ + +A hint applied to the uniform, which controls the values it can take when set through the inspector. + +---- + +.. _class_VisualShaderNodeFloatUniform_property_max: + +- :ref:`float` **max** + ++-----------+----------------+ +| *Default* | ``1.0`` | ++-----------+----------------+ +| *Setter* | set_max(value) | ++-----------+----------------+ +| *Getter* | get_max() | ++-----------+----------------+ + +Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. + +---- + +.. _class_VisualShaderNodeFloatUniform_property_min: + +- :ref:`float` **min** + ++-----------+----------------+ +| *Default* | ``0.0`` | ++-----------+----------------+ +| *Setter* | set_min(value) | ++-----------+----------------+ +| *Getter* | get_min() | ++-----------+----------------+ + +Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. + +---- + +.. _class_VisualShaderNodeFloatUniform_property_step: + +- :ref:`float` **step** + ++-----------+-----------------+ +| *Default* | ``0.1`` | ++-----------+-----------------+ +| *Setter* | set_step(value) | ++-----------+-----------------+ +| *Getter* | get_step() | ++-----------+-----------------+ + +Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. + diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 3073dfb43..cffa2ec26 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -11,5 +11,10 @@ VisualShaderNodeIf **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +Compares two floating-point numbers in order to return a required vector within the visual shader graph. +Description +----------- + +First two ports are scalar floatin-point numbers to compare, third is tolerance comparison amount and last three ports represents a vectors returned if ``a == b``, ``a > b`` and ``a < b`` respectively. diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index a51b41d26..25f4f864a 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -11,7 +11,7 @@ VisualShaderNodeInput **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +Represents the input shader parameter within the visual shader graph. Properties ---------- @@ -34,6 +34,8 @@ Signals - **input_type_changed** **(** **)** +Emitted when input is changed via :ref:`input_name`. + Property Descriptions --------------------- @@ -49,6 +51,8 @@ Property Descriptions | *Getter* | get_input_name() | +-----------+-----------------------+ +One of the several input constants in lower-case style like: "vertex"(``\ VERTEX``) or "point_size"([code]POINT_SIZE``). + Method Descriptions ------------------- @@ -56,3 +60,5 @@ Method Descriptions - :ref:`String` **get_input_real_name** **(** **)** const +Returns a translated name of the current constant in the Godot Shader Language. eg. ``"ALBEDO"`` if the :ref:`input_name` equal to ``"albedo"``. + diff --git a/classes/class_visualshadernodeintconstant.rst b/classes/class_visualshadernodeintconstant.rst new file mode 100644 index 000000000..51b9af265 --- /dev/null +++ b/classes/class_visualshadernodeintconstant.rst @@ -0,0 +1,44 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeIntConstant: + +VisualShaderNodeIntConstant +=========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A scalar integer constant to be used within the visual shader graph. + +Description +----------- + +Translated to ``int`` in the shader language. + +Properties +---------- + ++-----------------------+----------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`constant` | ``0`` | ++-----------------------+----------------------------------------------------------------------+-------+ + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeIntConstant_property_constant: + +- :ref:`int` **constant** + ++-----------+---------------------+ +| *Default* | ``0`` | ++-----------+---------------------+ +| *Setter* | set_constant(value) | ++-----------+---------------------+ +| *Getter* | get_constant() | ++-----------+---------------------+ + +An integer constant which represents a state of this node. + diff --git a/classes/class_visualshadernodeintfunc.rst b/classes/class_visualshadernodeintfunc.rst new file mode 100644 index 000000000..61a37c638 --- /dev/null +++ b/classes/class_visualshadernodeintfunc.rst @@ -0,0 +1,67 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeIntFunc: + +VisualShaderNodeIntFunc +======================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A scalar integer function to be used within the visual shader graph. + +Description +----------- + +Accept an integer scalar (``x``) to the input port and transform it according to :ref:`function`. + +Properties +---------- + ++--------------------------------------------------------+------------------------------------------------------------------+-------+ +| :ref:`Function` | :ref:`function` | ``3`` | ++--------------------------------------------------------+------------------------------------------------------------------+-------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeIntFunc_Function: + +.. _class_VisualShaderNodeIntFunc_constant_FUNC_ABS: + +.. _class_VisualShaderNodeIntFunc_constant_FUNC_CLAMP: + +.. _class_VisualShaderNodeIntFunc_constant_FUNC_NEGATE: + +.. _class_VisualShaderNodeIntFunc_constant_FUNC_SIGN: + +enum **Function**: + +- **FUNC_ABS** = **0** --- Returns the absolute value of the parameter. Translates to ``abs(x)`` in the Godot Shader Language. + +- **FUNC_CLAMP** = **1** --- Constrains a parameter between ``min`` and ``max``. Translates to ``clamp(x, min, max)`` in the Godot Shader Language. + +- **FUNC_NEGATE** = **2** --- Negates the ``x`` using ``-(x)``. + +- **FUNC_SIGN** = **3** --- Extracts the sign of the parameter. Translates to ``sign(x)`` in the Godot Shader Language. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeIntFunc_property_function: + +- :ref:`Function` **function** + ++-----------+---------------------+ +| *Default* | ``3`` | ++-----------+---------------------+ +| *Setter* | set_function(value) | ++-----------+---------------------+ +| *Getter* | get_function() | ++-----------+---------------------+ + +A function to be applied to the scalar. See :ref:`Function` for options. + diff --git a/classes/class_visualshadernodeintop.rst b/classes/class_visualshadernodeintop.rst new file mode 100644 index 000000000..041a76ff0 --- /dev/null +++ b/classes/class_visualshadernodeintop.rst @@ -0,0 +1,79 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntOp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeIntOp: + +VisualShaderNodeIntOp +===================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +An integer scalar operator to be used within the visual shader graph. + +Description +----------- + +Applies :ref:`operator` to two integer inputs: ``a`` and ``b``. + +Properties +---------- + ++------------------------------------------------------+----------------------------------------------------------------+-------+ +| :ref:`Operator` | :ref:`operator` | ``0`` | ++------------------------------------------------------+----------------------------------------------------------------+-------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeIntOp_Operator: + +.. _class_VisualShaderNodeIntOp_constant_OP_ADD: + +.. _class_VisualShaderNodeIntOp_constant_OP_SUB: + +.. _class_VisualShaderNodeIntOp_constant_OP_MUL: + +.. _class_VisualShaderNodeIntOp_constant_OP_DIV: + +.. _class_VisualShaderNodeIntOp_constant_OP_MOD: + +.. _class_VisualShaderNodeIntOp_constant_OP_MAX: + +.. _class_VisualShaderNodeIntOp_constant_OP_MIN: + +enum **Operator**: + +- **OP_ADD** = **0** --- Sums two numbers using ``a + b``. + +- **OP_SUB** = **1** --- Subtracts two numbers using ``a - b``. + +- **OP_MUL** = **2** --- Multiplies two numbers using ``a * b``. + +- **OP_DIV** = **3** --- Divides two numbers using ``a / b``. + +- **OP_MOD** = **4** --- Calculates the remainder of two numbers using ``a % b``. + +- **OP_MAX** = **5** --- Returns the greater of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language. + +- **OP_MIN** = **6** --- Returns the lesser of two numbers. Translates to ``max(a, b)`` in the Godot Shader Language. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeIntOp_property_operator: + +- :ref:`Operator` **operator** + ++-----------+---------------------+ +| *Default* | ``0`` | ++-----------+---------------------+ +| *Setter* | set_operator(value) | ++-----------+---------------------+ +| *Getter* | get_operator() | ++-----------+---------------------+ + +An operator to be applied to the inputs. See :ref:`Operator` for options. + diff --git a/classes/class_visualshadernodeintuniform.rst b/classes/class_visualshadernodeintuniform.rst new file mode 100644 index 000000000..419a4361f --- /dev/null +++ b/classes/class_visualshadernodeintuniform.rst @@ -0,0 +1,117 @@ +:github_url: hide + +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIntUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeIntUniform: + +VisualShaderNodeIntUniform +========================== + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +A scalar integer uniform to be used within the visual shader graph. + +Description +----------- + +Translated to ``uniform int`` in the shader language. + +Properties +---------- + ++---------------------------------------------------+-------------------------------------------------------------+---------+ +| :ref:`Hint` | :ref:`hint` | ``0`` | ++---------------------------------------------------+-------------------------------------------------------------+---------+ +| :ref:`int` | :ref:`max` | ``100`` | ++---------------------------------------------------+-------------------------------------------------------------+---------+ +| :ref:`int` | :ref:`min` | ``0`` | ++---------------------------------------------------+-------------------------------------------------------------+---------+ +| :ref:`int` | :ref:`step` | ``1`` | ++---------------------------------------------------+-------------------------------------------------------------+---------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeIntUniform_Hint: + +.. _class_VisualShaderNodeIntUniform_constant_HINT_NONE: + +.. _class_VisualShaderNodeIntUniform_constant_HINT_RANGE: + +.. _class_VisualShaderNodeIntUniform_constant_HINT_RANGE_STEP: + +enum **Hint**: + +- **HINT_NONE** = **0** --- No hint used. + +- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. + +- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeIntUniform_property_hint: + +- :ref:`Hint` **hint** + ++-----------+-----------------+ +| *Default* | ``0`` | ++-----------+-----------------+ +| *Setter* | set_hint(value) | ++-----------+-----------------+ +| *Getter* | get_hint() | ++-----------+-----------------+ + +A hint applied to the uniform, which controls the values it can take when set through the inspector. + +---- + +.. _class_VisualShaderNodeIntUniform_property_max: + +- :ref:`int` **max** + ++-----------+----------------+ +| *Default* | ``100`` | ++-----------+----------------+ +| *Setter* | set_max(value) | ++-----------+----------------+ +| *Getter* | get_max() | ++-----------+----------------+ + +Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. + +---- + +.. _class_VisualShaderNodeIntUniform_property_min: + +- :ref:`int` **min** + ++-----------+----------------+ +| *Default* | ``0`` | ++-----------+----------------+ +| *Setter* | set_min(value) | ++-----------+----------------+ +| *Getter* | get_min() | ++-----------+----------------+ + +Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. + +---- + +.. _class_VisualShaderNodeIntUniform_property_step: + +- :ref:`int` **step** + ++-----------+-----------------+ +| *Default* | ``1`` | ++-----------+-----------------+ +| *Setter* | set_step(value) | ++-----------+-----------------+ +| *Getter* | get_step() | ++-----------+-----------------+ + +Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. + diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst deleted file mode 100644 index 7021b8b38..000000000 --- a/classes/class_visualshadernodescalarfunc.rst +++ /dev/null @@ -1,172 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarFunc.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_VisualShaderNodeScalarFunc: - -VisualShaderNodeScalarFunc -========================== - -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - - - -Properties ----------- - -+-----------------------------------------------------------+---------------------------------------------------------------------+--------+ -| :ref:`Function` | :ref:`function` | ``13`` | -+-----------------------------------------------------------+---------------------------------------------------------------------+--------+ - -Enumerations ------------- - -.. _enum_VisualShaderNodeScalarFunc_Function: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COS: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TAN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASIN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOS: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATAN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SINH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_COSH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TANH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SQRT: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ABS: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SIGN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FLOOR: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUND: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_CEIL: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_FRAC: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_SATURATE: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOSH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASINH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATANH: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_DEGREES: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP2: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_INVERSE_SQRT: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG2: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RADIANS: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RECIPROCAL: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUNDEVEN: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TRUNC: - -.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ONEMINUS: - -enum **Function**: - -- **FUNC_SIN** = **0** - -- **FUNC_COS** = **1** - -- **FUNC_TAN** = **2** - -- **FUNC_ASIN** = **3** - -- **FUNC_ACOS** = **4** - -- **FUNC_ATAN** = **5** - -- **FUNC_SINH** = **6** - -- **FUNC_COSH** = **7** - -- **FUNC_TANH** = **8** - -- **FUNC_LOG** = **9** - -- **FUNC_EXP** = **10** - -- **FUNC_SQRT** = **11** - -- **FUNC_ABS** = **12** - -- **FUNC_SIGN** = **13** - -- **FUNC_FLOOR** = **14** - -- **FUNC_ROUND** = **15** - -- **FUNC_CEIL** = **16** - -- **FUNC_FRAC** = **17** - -- **FUNC_SATURATE** = **18** - -- **FUNC_NEGATE** = **19** - -- **FUNC_ACOSH** = **20** - -- **FUNC_ASINH** = **21** - -- **FUNC_ATANH** = **22** - -- **FUNC_DEGREES** = **23** - -- **FUNC_EXP2** = **24** - -- **FUNC_INVERSE_SQRT** = **25** - -- **FUNC_LOG2** = **26** - -- **FUNC_RADIANS** = **27** - -- **FUNC_RECIPROCAL** = **28** - -- **FUNC_ROUNDEVEN** = **29** - -- **FUNC_TRUNC** = **30** - -- **FUNC_ONEMINUS** = **31** - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeScalarFunc_property_function: - -- :ref:`Function` **function** - -+-----------+---------------------+ -| *Default* | ``13`` | -+-----------+---------------------+ -| *Setter* | set_function(value) | -+-----------+---------------------+ -| *Getter* | get_function() | -+-----------+---------------------+ - diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst deleted file mode 100644 index b4833a20b..000000000 --- a/classes/class_visualshadernodescalarop.rst +++ /dev/null @@ -1,84 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarOp.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_VisualShaderNodeScalarOp: - -VisualShaderNodeScalarOp -======================== - -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - - - -Properties ----------- - -+---------------------------------------------------------+-------------------------------------------------------------------+-------+ -| :ref:`Operator` | :ref:`operator` | ``0`` | -+---------------------------------------------------------+-------------------------------------------------------------------+-------+ - -Enumerations ------------- - -.. _enum_VisualShaderNodeScalarOp_Operator: - -.. _class_VisualShaderNodeScalarOp_constant_OP_ADD: - -.. _class_VisualShaderNodeScalarOp_constant_OP_SUB: - -.. _class_VisualShaderNodeScalarOp_constant_OP_MUL: - -.. _class_VisualShaderNodeScalarOp_constant_OP_DIV: - -.. _class_VisualShaderNodeScalarOp_constant_OP_MOD: - -.. _class_VisualShaderNodeScalarOp_constant_OP_POW: - -.. _class_VisualShaderNodeScalarOp_constant_OP_MAX: - -.. _class_VisualShaderNodeScalarOp_constant_OP_MIN: - -.. _class_VisualShaderNodeScalarOp_constant_OP_ATAN2: - -.. _class_VisualShaderNodeScalarOp_constant_OP_STEP: - -enum **Operator**: - -- **OP_ADD** = **0** - -- **OP_SUB** = **1** - -- **OP_MUL** = **2** - -- **OP_DIV** = **3** - -- **OP_MOD** = **4** - -- **OP_POW** = **5** - -- **OP_MAX** = **6** - -- **OP_MIN** = **7** - -- **OP_ATAN2** = **8** - -- **OP_STEP** = **9** - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeScalarOp_property_operator: - -- :ref:`Operator` **operator** - -+-----------+---------------------+ -| *Default* | ``0`` | -+-----------+---------------------+ -| *Setter* | set_operator(value) | -+-----------+---------------------+ -| *Getter* | get_operator() | -+-----------+---------------------+ - diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst deleted file mode 100644 index 5ca6b5dfb..000000000 --- a/classes/class_visualshadernodescalaruniform.rst +++ /dev/null @@ -1,15 +0,0 @@ -:github_url: hide - -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarUniform.xml source instead. -.. The source is found in doc/classes or modules//doc_classes. - -.. _class_VisualShaderNodeScalarUniform: - -VisualShaderNodeScalarUniform -============================= - -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - - - diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index ac489d435..e7132dfd1 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -19,7 +19,7 @@ Properties +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ | :ref:`Source` | :ref:`source` | ``0`` | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ -| :ref:`Texture` | :ref:`texture` | | +| :ref:`Texture2D` | :ref:`texture` | | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ | :ref:`TextureType` | :ref:`texture_type` | ``0`` | +--------------------------------------------------------------+--------------------------------------------------------------------------+-------+ @@ -92,7 +92,7 @@ Property Descriptions .. _class_VisualShaderNodeTexture_property_texture: -- :ref:`Texture` **texture** +- :ref:`Texture2D` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 57cdfa741..961fb5724 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -11,7 +11,7 @@ VisualShaderNodeTextureUniform **Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeTextureUniformTriplanar` +**Inherited By:** :ref:`VisualShaderNodeCubemapUniform`, :ref:`VisualShaderNodeTextureUniformTriplanar` diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index f823bee9b..b02340169 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -11,7 +11,7 @@ VisualShaderNodeUniform **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeBooleanUniform`, :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec3Uniform` +**Inherited By:** :ref:`VisualShaderNodeBooleanUniform`, :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeFloatUniform`, :ref:`VisualShaderNodeIntUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec3Uniform` diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index 6dd5ee7ee..bf8ba37b6 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -30,23 +30,23 @@ Properties Theme Properties ---------------- -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement | -+---------------------------------+---------------------+ -| :ref:`Texture` | decrement_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | grabber_pressed | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment | -+---------------------------------+---------------------+ -| :ref:`Texture` | increment_highlight | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | scroll | -+---------------------------------+---------------------+ -| :ref:`StyleBox` | scroll_focus | -+---------------------------------+---------------------+ ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | decrement | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | decrement_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | grabber_pressed | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | increment | ++-----------------------------------+---------------------+ +| :ref:`Texture2D` | increment_highlight | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | scroll | ++-----------------------------------+---------------------+ +| :ref:`StyleBox` | scroll_focus | ++-----------------------------------+---------------------+ diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 670a3dd46..1c546ae39 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -30,17 +30,17 @@ Properties Theme Properties ---------------- -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber | -+---------------------------------+-------------------+ -| :ref:`StyleBox` | grabber_area | -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber_disabled | -+---------------------------------+-------------------+ -| :ref:`Texture` | grabber_highlight | -+---------------------------------+-------------------+ -| :ref:`StyleBox` | slider | -+---------------------------------+-------------------+ -| :ref:`Texture` | tick | -+---------------------------------+-------------------+ ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber | ++-----------------------------------+-------------------+ +| :ref:`StyleBox` | grabber_area | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber_disabled | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | grabber_highlight | ++-----------------------------------+-------------------+ +| :ref:`StyleBox` | slider | ++-----------------------------------+-------------------+ +| :ref:`Texture2D` | tick | ++-----------------------------------+-------------------+ diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 65f8b5cf3..11f9b5fd1 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -21,13 +21,13 @@ Vertical split container. See :ref:`SplitContainer`. This Theme Properties ---------------- -+---------------------------------+------------+----+ -| :ref:`int` | autohide | 1 | -+---------------------------------+------------+----+ -| :ref:`StyleBox` | bg | | -+---------------------------------+------------+----+ -| :ref:`Texture` | grabber | | -+---------------------------------+------------+----+ -| :ref:`int` | separation | 12 | -+---------------------------------+------------+----+ ++-----------------------------------+------------+----+ +| :ref:`int` | autohide | 1 | ++-----------------------------------+------------+----+ +| :ref:`StyleBox` | bg | | ++-----------------------------------+------------+----+ +| :ref:`Texture2D` | grabber | | ++-----------------------------------+------------+----+ +| :ref:`int` | separation | 12 | ++-----------------------------------+------------+----+ diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index effbaf6f6..d54e84b14 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -36,15 +36,15 @@ Properties Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false, :ref:`PoolStringArray` custom_headers=PoolStringArray( ) **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_host` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_connected_port` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PackedStringArray` protocols=PackedStringArray( ), :ref:`bool` gd_mp_api=false, :ref:`PackedStringArray` custom_headers=PackedStringArray( ) **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_from_host` **(** :ref:`int` code=1000, :ref:`String` reason="" **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_connected_port` **(** **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -127,7 +127,7 @@ Method Descriptions .. _class_WebSocketClient_method_connect_to_url: -- :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false, :ref:`PoolStringArray` custom_headers=PoolStringArray( ) **)** +- :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PackedStringArray` protocols=PackedStringArray( ), :ref:`bool` gd_mp_api=false, :ref:`PackedStringArray` custom_headers=PackedStringArray( ) **)** Connects to the given URL requesting one of the given ``protocols`` as sub-protocol. If the list empty (default), no sub-protocol will be requested. diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index c477b1c78..075bb35de 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -38,21 +38,21 @@ Properties Methods ------- -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`int` code=1000, :ref:`String` reason="" **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_listening` **(** **)** const | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`int` code=1000, :ref:`String` reason="" **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_peer` **(** :ref:`int` id **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_listening` **(** **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PackedStringArray` protocols=PackedStringArray( ), :ref:`bool` gd_mp_api=false **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -193,7 +193,7 @@ Returns ``true`` if the server is actively listening on a port. .. _class_WebSocketServer_method_listen: -- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** +- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PackedStringArray` protocols=PackedStringArray( ), :ref:`bool` gd_mp_api=false **)** Starts listening on the given port. diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 3a021cf7d..83c93c461 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -39,25 +39,25 @@ Methods Theme Properties ---------------- -+---------------------------------+------------------+---------------------+ -| :ref:`Texture` | close | | -+---------------------------------+------------------+---------------------+ -| :ref:`int` | close_h_ofs | 18 | -+---------------------------------+------------------+---------------------+ -| :ref:`Texture` | close_highlight | | -+---------------------------------+------------------+---------------------+ -| :ref:`int` | close_v_ofs | 18 | -+---------------------------------+------------------+---------------------+ -| :ref:`StyleBox` | panel | | -+---------------------------------+------------------+---------------------+ -| :ref:`int` | scaleborder_size | 4 | -+---------------------------------+------------------+---------------------+ -| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | -+---------------------------------+------------------+---------------------+ -| :ref:`Font` | title_font | | -+---------------------------------+------------------+---------------------+ -| :ref:`int` | title_height | 20 | -+---------------------------------+------------------+---------------------+ ++-----------------------------------+------------------+---------------------+ +| :ref:`Texture2D` | close | | ++-----------------------------------+------------------+---------------------+ +| :ref:`int` | close_h_ofs | 18 | ++-----------------------------------+------------------+---------------------+ +| :ref:`Texture2D` | close_highlight | | ++-----------------------------------+------------------+---------------------+ +| :ref:`int` | close_v_ofs | 18 | ++-----------------------------------+------------------+---------------------+ +| :ref:`StyleBox` | panel | | ++-----------------------------------+------------------+---------------------+ +| :ref:`int` | scaleborder_size | 4 | ++-----------------------------------+------------------+---------------------+ +| :ref:`Color` | title_color | Color( 0, 0, 0, 1 ) | ++-----------------------------------+------------------+---------------------+ +| :ref:`Font` | title_font | | ++-----------------------------------+------------------+---------------------+ +| :ref:`int` | title_height | 20 | ++-----------------------------------+------------------+---------------------+ Property Descriptions --------------------- diff --git a/classes/class_world.rst b/classes/class_world.rst index 6b8d31006..771beda07 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -26,6 +26,8 @@ Tutorials Properties ---------- ++---------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`CameraEffects` | :ref:`camera_effects` | +---------------------------------------------------------------+------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState` | :ref:`direct_space_state` | +---------------------------------------------------------------+------------------------------------------------------------------------+ @@ -41,6 +43,18 @@ Properties Property Descriptions --------------------- +.. _class_World_property_camera_effects: + +- :ref:`CameraEffects` **camera_effects** + ++----------+---------------------------+ +| *Setter* | set_camera_effects(value) | ++----------+---------------------------+ +| *Getter* | get_camera_effects() | ++----------+---------------------------+ + +---- + .. _class_World_property_direct_space_state: - :ref:`PhysicsDirectSpaceState` **direct_space_state** diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 6d8b13c83..a3409741c 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -30,13 +30,27 @@ Tutorials Properties ---------- -+---------------------------------------+-----------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+---------------------------------------+-----------------------------------------------------------------+ ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`CameraEffects` | :ref:`camera_effects` | ++-------------------------------------------+-----------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++-------------------------------------------+-----------------------------------------------------------------------+ Property Descriptions --------------------- +.. _class_WorldEnvironment_property_camera_effects: + +- :ref:`CameraEffects` **camera_effects** + ++----------+---------------------------+ +| *Setter* | set_camera_effects(value) | ++----------+---------------------------+ +| *Getter* | get_camera_effects() | ++----------+---------------------------+ + +---- + .. _class_WorldEnvironment_property_environment: - :ref:`Environment` **environment** diff --git a/classes/class_planeshape.rst b/classes/class_worldmarginshape.rst similarity index 61% rename from classes/class_planeshape.rst rename to classes/class_worldmarginshape.rst index 2a3935df7..e0e8902ca 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_worldmarginshape.rst @@ -1,13 +1,13 @@ :github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the PlaneShape.xml source instead. +.. DO NOT EDIT THIS FILE, but the WorldMarginShape.xml source instead. .. The source is found in doc/classes or modules//doc_classes. -.. _class_PlaneShape: +.. _class_WorldMarginShape: -PlaneShape -========== +WorldMarginShape +================ **Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` @@ -16,19 +16,19 @@ Infinite plane shape for 3D collisions. Description ----------- -An infinite plane shape for 3D collisions. Note that the :ref:`Plane`'s normal matters; anything "below" the plane will collide with it. If the ``PlaneShape`` is used in a :ref:`PhysicsBody`, it will cause colliding objects placed "below" it to teleport "above" the plane. +An infinite plane shape for 3D collisions. Note that the :ref:`Plane`'s normal matters; anything "below" the plane will collide with it. If the ``WorldMarginShape`` is used in a :ref:`PhysicsBody`, it will cause colliding objects placed "below" it to teleport "above" the plane. Properties ---------- -+---------------------------+-----------------------------------------------+-------------------------+ -| :ref:`Plane` | :ref:`plane` | ``Plane( 0, 1, 0, 0 )`` | -+---------------------------+-----------------------------------------------+-------------------------+ ++---------------------------+-----------------------------------------------------+-------------------------+ +| :ref:`Plane` | :ref:`plane` | ``Plane( 0, 1, 0, 0 )`` | ++---------------------------+-----------------------------------------------------+-------------------------+ Property Descriptions --------------------- -.. _class_PlaneShape_property_plane: +.. _class_WorldMarginShape_property_plane: - :ref:`Plane` **plane** @@ -40,5 +40,5 @@ Property Descriptions | *Getter* | get_plane() | +-----------+-------------------------+ -The :ref:`Plane` used by the ``PlaneShape`` for collision. +The :ref:`Plane` used by the ``WorldMarginShape`` for collision. diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 56e1ef3b0..38303cd65 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -48,7 +48,7 @@ Methods +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`open` **(** :ref:`String` file **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PackedByteArray` buffer **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`read` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -201,7 +201,7 @@ Opens an XML file for parsing. This returns an error code. .. _class_XMLParser_method_open_buffer: -- :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **open_buffer** **(** :ref:`PackedByteArray` buffer **)** Opens an XML raw buffer for parsing. This returns an error code.