stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current 3.4 branch

Browse Source
This commit is contained in:
Rémi Verschelde
2021-08-03 11:06:30 +02:00
parent 392fd854fd
commit 9a6463b5b1
125 changed files with 867 additions and 404 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_animatedsprite.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Tutorials
- :doc:`../tutorials/2d/2d_sprite_animation`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
Properties
----------
classes/class_animationnodeadd3.rst
+1 -1
View File
@@ -31,7 +31,7 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationnodeanimation.rst
+2 -2
View File
@@ -23,9 +23,9 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationnodeblend2.rst
+2 -2
View File
@@ -23,9 +23,9 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationnodeblendspace2d.rst
+1 -1
View File
@@ -27,7 +27,7 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationnodeoneshot.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationnodeoutput.rst
+2 -2
View File
@@ -18,9 +18,9 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
classes/class_animationnodetimescale.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
classes/class_animationnodetransition.rst
+2 -2
View File
@@ -23,9 +23,9 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationplayer.rst
+1 -1
View File
@@ -29,7 +29,7 @@ Tutorials
- :doc:`../tutorials/2d/2d_sprite_animation`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_animationtree.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Tutorials
- :doc:`../tutorials/animation/animation_tree`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_area.rst
+2 -2
View File
@@ -21,9 +21,9 @@ Description
Tutorials
---------
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/127 <https://godotengine.org/asset-library/asset/127>`_
- `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`_
Properties
----------
classes/class_area2d.rst
+3 -3
View File
@@ -23,11 +23,11 @@ Tutorials
- :doc:`../tutorials/physics/using_area_2d`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/121 <https://godotengine.org/asset-library/asset/121>`_
- `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`_
- `https://godotengine.org/asset-library/asset/120 <https://godotengine.org/asset-library/asset/120>`_
- `2D Platformer Demo <https://godotengine.org/asset-library/asset/120>`_
Properties
----------
classes/class_arraymesh.rst
+38 -38
View File
@@ -59,43 +59,43 @@ Properties
Methods
-------
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_surfaces<class_ArrayMesh_method_clear_surfaces>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_ArrayMesh_method_regen_normalmaps>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_shape_name<class_ArrayMesh_method_set_blend_shape_name>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_remove<class_ArrayMesh_method_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_blend_shape<class_ArrayMesh_method_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=2194432 **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_surfaces<class_ArrayMesh_method_clear_surfaces>` **(** **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ArrayMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`lightmap_unwrap<class_ArrayMesh_method_lightmap_unwrap>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` texel_size **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_ArrayMesh_method_regen_normalmaps>` **(** **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_shape_name<class_ArrayMesh_method_set_blend_shape_name>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_find_by_name<class_ArrayMesh_method_surface_find_by_name>` **(** :ref:`String<class_String>` name **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_method_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_method_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_method_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`surface_get_name<class_ArrayMesh_method_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`surface_get_primitive_type<class_ArrayMesh_method_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** |const| |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_remove<class_ArrayMesh_method_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_name<class_ArrayMesh_method_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_String>` name **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_update_region<class_ArrayMesh_method_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_PoolByteArray>` data **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -245,7 +245,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<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)**
- void **add_surface_from_arrays** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=2194432 **)**
Creates a new surface.
classes/class_audioeffect.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Base resource for audio bus. Applies an audio effect on the bus that the resourc
Tutorials
---------
- `https://godotengine.org/asset-library/asset/527 <https://godotengine.org/asset-library/asset/527>`_
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`_
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
classes/class_audioeffectrecord.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Tutorials
- :doc:`../tutorials/audio/recording_with_microphone`
- `https://godotengine.org/asset-library/asset/527 <https://godotengine.org/asset-library/asset/527>`_
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`_
Properties
----------
classes/class_audioeffectreverb.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t
Tutorials
---------
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_audioeffectspectrumanalyzer.rst
+2 -2
View File
@@ -23,9 +23,9 @@ See also :ref:`AudioStreamGenerator<class_AudioStreamGenerator>` for procedurall
Tutorials
---------
- `Audio Spectrum Demo <Audio Spectrum Demo>`_
- `https://godotengine.org/asset-library/asset/528 <Audio Spectrum Demo>`_
- `Godot 3.2 will get new audio features <Godot 3.2 will get new audio features>`_
- `https://godotengine.org/article/godot-32-will-get-new-audio-features <Godot 3.2 will get new audio features>`_
Properties
----------
classes/class_audioserver.rst
+3 -3
View File
@@ -23,11 +23,11 @@ Tutorials
- :doc:`../tutorials/audio/audio_buses`
- `https://godotengine.org/asset-library/asset/525 <https://godotengine.org/asset-library/asset/525>`_
- `Audio Device Changer Demo <https://godotengine.org/asset-library/asset/525>`_
- `https://godotengine.org/asset-library/asset/527 <https://godotengine.org/asset-library/asset/527>`_
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`_
- `https://godotengine.org/asset-library/asset/528 <https://godotengine.org/asset-library/asset/528>`_
- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`_
Properties
----------
classes/class_audiostream.rst
+3 -3
View File
@@ -25,11 +25,11 @@ Tutorials
- :doc:`../tutorials/audio/audio_streams`
- `https://godotengine.org/asset-library/asset/526 <https://godotengine.org/asset-library/asset/526>`_
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`_
- `https://godotengine.org/asset-library/asset/527 <https://godotengine.org/asset-library/asset/527>`_
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`_
- `https://godotengine.org/asset-library/asset/528 <https://godotengine.org/asset-library/asset/528>`_
- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`_
Methods
-------
classes/class_audiostreamgenerator.rst
+2 -2
View File
@@ -25,9 +25,9 @@ See also :ref:`AudioEffectSpectrumAnalyzer<class_AudioEffectSpectrumAnalyzer>` f
Tutorials
---------
- `https://godotengine.org/asset-library/asset/526 <https://godotengine.org/asset-library/asset/526>`_
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`_
- `Godot 3.2 will get new audio features <Godot 3.2 will get new audio features>`_
- `https://godotengine.org/article/godot-32-will-get-new-audio-features <Godot 3.2 will get new audio features>`_
Properties
----------
classes/class_audiostreamgeneratorplayback.rst
+2 -2
View File
@@ -21,9 +21,9 @@ This class is meant to be used with :ref:`AudioStreamGenerator<class_AudioStream
Tutorials
---------
- `https://godotengine.org/asset-library/asset/526 <https://godotengine.org/asset-library/asset/526>`_
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`_
- `Godot 3.2 will get new audio features <Godot 3.2 will get new audio features>`_
- `https://godotengine.org/article/godot-32-will-get-new-audio-features <Godot 3.2 will get new audio features>`_
Methods
-------
classes/class_audiostreamplayback.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Can play, loop, pause a scroll through audio. See :ref:`AudioStream<class_AudioS
Tutorials
---------
- `https://godotengine.org/asset-library/asset/526 <https://godotengine.org/asset-library/asset/526>`_
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`_
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
classes/class_audiostreamplayer.rst
+5 -5
View File
@@ -25,15 +25,15 @@ Tutorials
- :doc:`../tutorials/audio/audio_streams`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/525 <https://godotengine.org/asset-library/asset/525>`_
- `Audio Device Changer Demo <https://godotengine.org/asset-library/asset/525>`_
- `https://godotengine.org/asset-library/asset/526 <https://godotengine.org/asset-library/asset/526>`_
- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`_
- `https://godotengine.org/asset-library/asset/527 <https://godotengine.org/asset-library/asset/527>`_
- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`_
- `https://godotengine.org/asset-library/asset/528 <https://godotengine.org/asset-library/asset/528>`_
- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`_
Properties
----------
classes/class_bakedlightmap.rst
+24 -2
View File
@@ -18,6 +18,8 @@ Description
Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe<class_GIProbe>` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.
**Note:** Due to how lightmaps work, most properties only have a visible effect once lightmaps are baked again.
Tutorials
---------
@@ -33,6 +35,8 @@ Properties
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`float<class_float>` | :ref:`bias<class_BakedLightmap_property_bias>` | ``0.005`` |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`float<class_float>` | :ref:`bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>` | ``1.0`` |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`int<class_int>` | :ref:`bounces<class_BakedLightmap_property_bounces>` | ``3`` |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+---------------------------+
| :ref:`float<class_float>` | :ref:`capture_cell_size<class_BakedLightmap_property_capture_cell_size>` | ``0.5`` |
@@ -209,7 +213,25 @@ Maximum size of each lightmap layer, only used when :ref:`atlas_generate<class_B
| *Getter* | get_bias() |
+-----------+-----------------+
Raycasting bias used during baking to avoid floating point precission issues.
Raycasting bias used during baking to avoid floating point precision issues.
----
.. _class_BakedLightmap_property_bounce_indirect_energy:
- :ref:`float<class_float>` **bounce_indirect_energy**
+-----------+-----------------------------------+
| *Default* | ``1.0`` |
+-----------+-----------------------------------+
| *Setter* | set_bounce_indirect_energy(value) |
+-----------+-----------------------------------+
| *Getter* | get_bounce_indirect_energy() |
+-----------+-----------------------------------+
The energy multiplier for each bounce. Higher values will make indirect lighting brighter. A value of ``1.0`` represents physically accurate behavior, but higher values can be used to make indirect lighting propagate more visibly when using a low number of bounces. This can be used to speed up bake times by lowering the number of :ref:`bounces<class_BakedLightmap_property_bounces>` then increasing :ref:`bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>`. Unlike :ref:`BakedLightmapData.energy<class_BakedLightmapData_property_energy>`, this property does not affect direct lighting emitted by light nodes, emissive materials and the environment.
**Note:** :ref:`bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>` only has an effect if :ref:`bounces<class_BakedLightmap_property_bounces>` is set to a value greater than or equal to ``1``.
----
@@ -225,7 +247,7 @@ Raycasting bias used during baking to avoid floating point precission issues.
| *Getter* | get_bounces() |
+-----------+--------------------+
Number of light bounces that are taken into account during baking.
Number of light bounces that are taken into account during baking. See also :ref:`bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>`.
----
classes/class_bakedlightmapdata.rst
+3 -1
View File
@@ -104,7 +104,9 @@ Property Descriptions
| *Getter* | get_energy() |
+-----------+-------------------+
Global energy multiplier for baked and dynamic capture objects.
Global energy multiplier for baked and dynamic capture objects. This can be changed at run-time without having to bake lightmaps again.
To adjust only the energy of indirect lighting (without affecting direct lighting or emissive materials), adjust :ref:`BakedLightmap.bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>` and bake lightmaps again.
----
classes/class_basis.rst
+4 -4
View File
@@ -31,13 +31,13 @@ Tutorials
- :doc:`../tutorials/3d/using_transforms`
- `https://godotengine.org/asset-library/asset/584 <https://godotengine.org/asset-library/asset/584>`_
- `Matrix Transform Demo <https://godotengine.org/asset-library/asset/584>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
- `https://godotengine.org/asset-library/asset/583 <https://godotengine.org/asset-library/asset/583>`_
- `2.5D Demo <https://godotengine.org/asset-library/asset/583>`_
Properties
----------
classes/class_boxshape.rst
+3 -3
View File
@@ -21,11 +21,11 @@ Description
Tutorials
---------
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
Properties
----------
classes/class_button.rst
+2 -2
View File
@@ -42,9 +42,9 @@ See also :ref:`BaseButton<class_BaseButton>` which contains common properties an
Tutorials
---------
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Properties
----------
classes/class_camera.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Camera is a special node that displays what is visible from its current location
Tutorials
---------
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_camera2d.rst
+3 -3
View File
@@ -25,11 +25,11 @@ Note that the ``Camera2D`` node's ``position`` doesn't represent the actual posi
Tutorials
---------
- `https://godotengine.org/asset-library/asset/120 <https://godotengine.org/asset-library/asset/120>`_
- `2D Platformer Demo <https://godotengine.org/asset-library/asset/120>`_
- `https://godotengine.org/asset-library/asset/112 <https://godotengine.org/asset-library/asset/112>`_
- `2D Isometric Demo <https://godotengine.org/asset-library/asset/112>`_
- `https://godotengine.org/asset-library/asset/110 <https://godotengine.org/asset-library/asset/110>`_
- `2D HDR Demo <https://godotengine.org/asset-library/asset/110>`_
Properties
----------
classes/class_canvasitem.rst
+1 -1
View File
@@ -37,7 +37,7 @@ Tutorials
- :doc:`../tutorials/2d/custom_drawing_in_2d`
- `https://godotengine.org/asset-library/asset/528 <https://godotengine.org/asset-library/asset/528>`_
- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`_
Properties
----------
classes/class_canvaslayer.rst
+1 -1
View File
@@ -27,7 +27,7 @@ Tutorials
- :doc:`../tutorials/2d/canvas_layers`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
Properties
----------
classes/class_capsuleshape.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Capsule shape for collisions.
Tutorials
---------
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
Properties
----------
classes/class_collisionshape.rst
+3 -3
View File
@@ -23,11 +23,11 @@ Tutorials
- :doc:`../tutorials/physics/physics_introduction`
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_collisionshape2d.rst
+3 -3
View File
@@ -23,11 +23,11 @@ Tutorials
- :doc:`../tutorials/physics/physics_introduction`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/121 <https://godotengine.org/asset-library/asset/121>`_
- `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`_
- `https://godotengine.org/asset-library/asset/113 <https://godotengine.org/asset-library/asset/113>`_
- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`_
Properties
----------
classes/class_color.rst
+3 -3
View File
@@ -27,11 +27,11 @@ If you want to supply values in a range of 0 to 255, you should use :ref:`@GDScr
Tutorials
---------
- `https://godotengine.org/asset-library/asset/517 <https://godotengine.org/asset-library/asset/517>`_
- `2D GD Paint Demo <https://godotengine.org/asset-library/asset/517>`_
- `https://godotengine.org/asset-library/asset/146 <https://godotengine.org/asset-library/asset/146>`_
- `Tween Demo <https://godotengine.org/asset-library/asset/146>`_
- `https://godotengine.org/asset-library/asset/133 <https://godotengine.org/asset-library/asset/133>`_
- `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/133>`_
Properties
----------
classes/class_colorpicker.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Description
Tutorials
---------
- `https://godotengine.org/asset-library/asset/146 <https://godotengine.org/asset-library/asset/146>`_
- `Tween Demo <https://godotengine.org/asset-library/asset/146>`_
Properties
----------
classes/class_colorpickerbutton.rst
+2 -2
View File
@@ -23,9 +23,9 @@ See also :ref:`BaseButton<class_BaseButton>` which contains common properties an
Tutorials
---------
- `https://godotengine.org/asset-library/asset/133 <https://godotengine.org/asset-library/asset/133>`_
- `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/133>`_
- `https://godotengine.org/asset-library/asset/517 <https://godotengine.org/asset-library/asset/517>`_
- `2D GD Paint Demo <https://godotengine.org/asset-library/asset/517>`_
Properties
----------
classes/class_colorrect.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Displays a rectangle filled with a solid :ref:`color<class_ColorRect_property_co
Tutorials
---------
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
Properties
----------
classes/class_concavepolygonshape.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Note: when used for collision, ``ConcavePolygonShape`` is intended to work with
Tutorials
---------
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
Methods
-------
classes/class_control.rst
+1 -1
View File
@@ -43,7 +43,7 @@ Tutorials
- :doc:`../tutorials/gui/control_node_gallery`
- `https://github.com/godotengine/godot-demo-projects/tree/master/gui <https://github.com/godotengine/godot-demo-projects/tree/master/gui>`_
- `All GUI Demos <https://github.com/godotengine/godot-demo-projects/tree/master/gui>`_
Properties
----------
classes/class_convexpolygonshape.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody<class_P
Tutorials
---------
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
Properties
----------
classes/class_cullinstance.rst
+27 -5
View File
@@ -31,11 +31,13 @@ Objects that are not ``Static`` or ``Dynamic`` can be freely created and deleted
Properties
----------
+-------------------------------------------------+-----------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`include_in_bound<class_CullInstance_property_include_in_bound>` | ``true`` |
+-------------------------------------------------+-----------------------------------------------------------------------+----------+
| :ref:`PortalMode<enum_CullInstance_PortalMode>` | :ref:`portal_mode<class_CullInstance_property_portal_mode>` | ``0`` |
+-------------------------------------------------+-----------------------------------------------------------------------+----------+
+-------------------------------------------------+---------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`autoplace_priority<class_CullInstance_property_autoplace_priority>` | ``0`` |
+-------------------------------------------------+---------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`include_in_bound<class_CullInstance_property_include_in_bound>` | ``true`` |
+-------------------------------------------------+---------------------------------------------------------------------------+----------+
| :ref:`PortalMode<enum_CullInstance_PortalMode>` | :ref:`portal_mode<class_CullInstance_property_portal_mode>` | ``0`` |
+-------------------------------------------------+---------------------------------------------------------------------------+----------+
Enumerations
------------
@@ -71,6 +73,26 @@ enum **PortalMode**:
Property Descriptions
---------------------
.. _class_CullInstance_property_autoplace_priority:
- :ref:`int<class_int>` **autoplace_priority**
+-----------+--------------------------------------+
| *Default* | ``0`` |
+-----------+--------------------------------------+
| *Setter* | set_portal_autoplace_priority(value) |
+-----------+--------------------------------------+
| *Getter* | get_portal_autoplace_priority() |
+-----------+--------------------------------------+
When set to ``0``, ``CullInstance``\ s will be autoplaced in the :ref:`Room<class_Room>` with the highest priority.
When set to a value other than ``0``, the system will attempt to autoplace in a :ref:`Room<class_Room>` with the ``autoplace_priority``, if it is present.
This can be used to control autoplacement of building exteriors in an outer :ref:`RoomGroup<class_RoomGroup>`.
----
.. _class_CullInstance_property_include_in_bound:
- :ref:`bool<class_bool>` **include_in_bound**
classes/class_cylindershape.rst
+3 -3
View File
@@ -21,11 +21,11 @@ Cylinder shape for collisions.
Tutorials
---------
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_dictionary.rst
+2 -2
View File
@@ -117,9 +117,9 @@ Tutorials
- `#dictionary <../getting_started/scripting/gdscript/gdscript_basics.html#dictionary>`_ in :doc:`../getting_started/scripting/gdscript/gdscript_basics`
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Methods
-------
classes/class_dynamicfont.rst
+1 -1
View File
@@ -32,7 +32,7 @@ DynamicFont uses the `FreeType <https://www.freetype.org/>`_ library for rasteri
Tutorials
---------
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_dynamicfontdata.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a ve
Tutorials
---------
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_engine.rst
+1 -1
View File
@@ -94,7 +94,7 @@ If ``true``, the script is currently running inside the editor. This is useful f
else:
simulate_physics()
See `Running code in the editor <https://docs.godotengine.org/en/stable/tutorials/misc/running_code_in_the_editor.html>`_ in the documentation for more information.
See `Running code in the editor <https://docs.godotengine.org/en/3.3/tutorials/misc/running_code_in_the_editor.html>`_ in the documentation for more information.
**Note:** To detect whether the script is run from an editor *build* (e.g. when pressing ``F5``), use :ref:`OS.has_feature<class_OS_method_has_feature>` with the ``"editor"`` argument instead. ``OS.has_feature("editor")`` will evaluate to ``true`` both when the code is running in the editor and when running the project from the editor, but it will evaluate to ``false`` when the code is run from an exported project.
classes/class_environment.rst
+3 -3
View File
@@ -35,11 +35,11 @@ Tutorials
- :doc:`../tutorials/3d/high_dynamic_range`
- `https://godotengine.org/asset-library/asset/123 <https://godotengine.org/asset-library/asset/123>`_
- `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`_
- `https://godotengine.org/asset-library/asset/110 <https://godotengine.org/asset-library/asset/110>`_
- `2D HDR Demo <https://godotengine.org/asset-library/asset/110>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_file.rst
+1 -1
View File
@@ -46,7 +46,7 @@ Tutorials
- :doc:`../getting_started/step_by_step/filesystem`
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_giprobe.rst
+1 -1
View File
@@ -29,7 +29,7 @@ Tutorials
- :doc:`../tutorials/3d/gi_probes`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_giprobedata.rst
+1 -1
View File
@@ -16,7 +16,7 @@ GIProbeData
Tutorials
---------
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_gridcontainer.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Notice that grid layout will preserve the columns and rows for every size of the
Tutorials
---------
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Properties
----------
classes/class_gridmap.rst
+2 -2
View File
@@ -31,9 +31,9 @@ Tutorials
- :doc:`../tutorials/3d/using_gridmaps`
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
Properties
----------
classes/class_image.rst
+2
View File
@@ -829,6 +829,8 @@ Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image.
Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` if Godot was compiled without the TinyEXR module.
**Note:** The TinyEXR module is disabled in non-editor builds, which means :ref:`save_exr<class_Image_method_save_exr>` will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` when it is called from an exported project.
----
.. _class_Image_method_save_png:
classes/class_input.rst
+133 -87
View File
@@ -23,94 +23,100 @@ Tutorials
- :doc:`../tutorials/inputs/index`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Methods
-------
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_press<class_Input_method_action_press>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` strength=1.0 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_release<class_Input_method_action_release>` **(** :ref:`String<class_String>` action **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_method_add_joy_mapping>` **(** :ref:`String<class_String>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_accelerometer<class_Input_method_get_accelerometer>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_Input_method_get_action_strength>` **(** :ref:`String<class_String>` action **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_connected_joypads<class_Input_method_get_connected_joypads>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CursorShape<enum_Input_CursorShape>` | :ref:`get_current_cursor_shape<class_Input_method_get_current_cursor_shape>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_gravity<class_Input_method_get_gravity>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_gyroscope<class_Input_method_get_gyroscope>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_method_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_method_get_joy_axis_index_from_string>` **(** :ref:`String<class_String>` axis **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_axis_string<class_Input_method_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_method_get_joy_button_index_from_string>` **(** :ref:`String<class_String>` button **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_button_string<class_Input_method_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_guid<class_Input_method_get_joy_guid>` **(** :ref:`int<class_int>` device **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_name<class_Input_method_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_method_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_joy_vibration_strength<class_Input_method_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_last_mouse_speed<class_Input_method_get_last_mouse_speed>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_magnetometer<class_Input_method_get_magnetometer>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_method_get_mouse_button_mask>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MouseMode<enum_Input_MouseMode>` | :ref:`get_mouse_mode<class_Input_method_get_mouse_mode>` **(** **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_method_is_action_just_pressed>` **(** :ref:`String<class_String>` action **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_method_is_action_just_released>` **(** :ref:`String<class_String>` action **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_method_is_action_pressed>` **(** :ref:`String<class_String>` action **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_method_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_method_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_method_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_method_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** |const| |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joy_connection_changed<class_Input_method_joy_connection_changed>` **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_String>` name, :ref:`String<class_String>` guid **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_input_event<class_Input_method_parse_input_event>` **(** :ref:`InputEvent<class_InputEvent>` event **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_method_remove_joy_mapping>` **(** :ref:`String<class_String>` guid **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_method_set_custom_mouse_cursor>` **(** :ref:`Resource<class_Resource>` image, :ref:`CursorShape<enum_Input_CursorShape>` shape=0, :ref:`Vector2<class_Vector2>` hotspot=Vector2( 0, 0 ) **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_cursor_shape<class_Input_method_set_default_cursor_shape>` **(** :ref:`CursorShape<enum_Input_CursorShape>` shape=0 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_method_set_mouse_mode>` **(** :ref:`MouseMode<enum_Input_MouseMode>` mode **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_accumulated_input<class_Input_method_set_use_accumulated_input>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`start_joy_vibration<class_Input_method_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_joy_vibration<class_Input_method_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`vibrate_handheld<class_Input_method_vibrate_handheld>` **(** :ref:`int<class_int>` duration_ms=500 **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_position<class_Input_method_warp_mouse_position>` **(** :ref:`Vector2<class_Vector2>` to **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_press<class_Input_method_action_press>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` strength=1.0 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_release<class_Input_method_action_release>` **(** :ref:`String<class_String>` action **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_method_add_joy_mapping>` **(** :ref:`String<class_String>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_accelerometer<class_Input_method_get_accelerometer>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_raw_strength<class_Input_method_get_action_raw_strength>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_Input_method_get_action_strength>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_axis<class_Input_method_get_axis>` **(** :ref:`String<class_String>` negative_action, :ref:`String<class_String>` positive_action **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_connected_joypads<class_Input_method_get_connected_joypads>` **(** **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CursorShape<enum_Input_CursorShape>` | :ref:`get_current_cursor_shape<class_Input_method_get_current_cursor_shape>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_gravity<class_Input_method_get_gravity>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_gyroscope<class_Input_method_get_gyroscope>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_method_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_method_get_joy_axis_index_from_string>` **(** :ref:`String<class_String>` axis **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_axis_string<class_Input_method_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_method_get_joy_button_index_from_string>` **(** :ref:`String<class_String>` button **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_button_string<class_Input_method_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_guid<class_Input_method_get_joy_guid>` **(** :ref:`int<class_int>` device **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_joy_name<class_Input_method_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_method_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_joy_vibration_strength<class_Input_method_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_last_mouse_speed<class_Input_method_get_last_mouse_speed>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_magnetometer<class_Input_method_get_magnetometer>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_method_get_mouse_button_mask>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MouseMode<enum_Input_MouseMode>` | :ref:`get_mouse_mode<class_Input_method_get_mouse_mode>` **(** **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_vector<class_Input_method_get_vector>` **(** :ref:`String<class_String>` negative_x, :ref:`String<class_String>` positive_x, :ref:`String<class_String>` negative_y, :ref:`String<class_String>` positive_y, :ref:`float<class_float>` deadzone=-1.0 **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_method_is_action_just_pressed>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_method_is_action_just_released>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_method_is_action_pressed>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_method_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_method_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_method_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_method_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** |const| |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`joy_connection_changed<class_Input_method_joy_connection_changed>` **(** :ref:`int<class_int>` device, :ref:`bool<class_bool>` connected, :ref:`String<class_String>` name, :ref:`String<class_String>` guid **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`parse_input_event<class_Input_method_parse_input_event>` **(** :ref:`InputEvent<class_InputEvent>` event **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_method_remove_joy_mapping>` **(** :ref:`String<class_String>` guid **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_method_set_custom_mouse_cursor>` **(** :ref:`Resource<class_Resource>` image, :ref:`CursorShape<enum_Input_CursorShape>` shape=0, :ref:`Vector2<class_Vector2>` hotspot=Vector2( 0, 0 ) **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_cursor_shape<class_Input_method_set_default_cursor_shape>` **(** :ref:`CursorShape<enum_Input_CursorShape>` shape=0 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_method_set_mouse_mode>` **(** :ref:`MouseMode<enum_Input_MouseMode>` mode **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_accumulated_input<class_Input_method_set_use_accumulated_input>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`start_joy_vibration<class_Input_method_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_joy_vibration<class_Input_method_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`vibrate_handheld<class_Input_method_vibrate_handheld>` **(** :ref:`int<class_int>` duration_ms=500 **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_position<class_Input_method_warp_mouse_position>` **(** :ref:`Vector2<class_Vector2>` to **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -263,12 +269,34 @@ Note this method returns an empty :ref:`Vector3<class_Vector3>` when running fro
----
.. _class_Input_method_get_action_raw_strength:
- :ref:`float<class_float>` **get_action_raw_strength** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const|
Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use :ref:`get_action_strength<class_Input_method_get_action_strength>` instead.
If ``exact`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_Input_method_get_action_strength:
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const|
Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1.
If ``exact`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_Input_method_get_axis:
- :ref:`float<class_float>` **get_axis** **(** :ref:`String<class_String>` negative_action, :ref:`String<class_String>` positive_action **)** |const|
Get axis input by specifying two actions, one negative and one positive.
This is a shorthand for writing ``Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")``.
----
.. _class_Input_method_get_connected_joypads:
@@ -413,30 +441,48 @@ Returns the mouse mode. See the constants for more information.
----
.. _class_Input_method_get_vector:
- :ref:`Vector2<class_Vector2>` **get_vector** **(** :ref:`String<class_String>` negative_x, :ref:`String<class_String>` positive_x, :ref:`String<class_String>` negative_y, :ref:`String<class_String>` positive_y, :ref:`float<class_float>` deadzone=-1.0 **)** |const|
Gets an input vector by specifying four actions for the positive and negative X and Y axes.
This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement.
By default, the deadzone is automatically calculated from the average of the action deadzones. However, you can override the deadzone to be whatever you want (on the range of 0 to 1).
----
.. _class_Input_method_is_action_just_pressed:
- :ref:`bool<class_bool>` **is_action_just_pressed** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **is_action_just_pressed** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const|
Returns ``true`` when the user starts pressing the action event, meaning it's ``true`` only on the frame that the user pressed down the button.
This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed.
If ``exact`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_Input_method_is_action_just_released:
- :ref:`bool<class_bool>` **is_action_just_released** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **is_action_just_released** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |const|
Returns ``true`` when the user stops pressing the action event, meaning it's ``true`` only on the frame that the user released the button.
If ``exact`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_Input_method_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact=false **)** |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.
If ``exact`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_Input_method_is_joy_button_pressed:
classes/class_inputevent.rst
+37 -29
View File
@@ -27,9 +27,9 @@ Tutorials
- :doc:`../tutorials/2d/2d_transforms`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
@@ -41,29 +41,29 @@ Properties
Methods
-------
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`accumulate<class_InputEvent_method_accumulate>` **(** :ref:`InputEvent<class_InputEvent>` with_event **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`as_text<class_InputEvent_method_as_text>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_InputEvent_method_get_action_strength>` **(** :ref:`String<class_String>` action **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_method_is_action>` **(** :ref:`String<class_String>` action **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_method_is_action_pressed>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` allow_echo=false **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_method_is_action_released>` **(** :ref:`String<class_String>` action **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_type<class_InputEvent_method_is_action_type>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_method_is_echo>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_method_is_pressed>` **(** **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shortcut_match<class_InputEvent_method_shortcut_match>` **(** :ref:`InputEvent<class_InputEvent>` event **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InputEvent<class_InputEvent>` | :ref:`xformed_by<class_InputEvent_method_xformed_by>` **(** :ref:`Transform2D<class_Transform2D>` xform, :ref:`Vector2<class_Vector2>` local_ofs=Vector2( 0, 0 ) **)** |const| |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`accumulate<class_InputEvent_method_accumulate>` **(** :ref:`InputEvent<class_InputEvent>` with_event **)** |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`as_text<class_InputEvent_method_as_text>` **(** **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_action_strength<class_InputEvent_method_get_action_strength>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_method_is_action>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_method_is_action_pressed>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` allow_echo=false, :ref:`bool<class_bool>` exact_match=false **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_method_is_action_released>` **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_type<class_InputEvent_method_is_action_type>` **(** **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_method_is_echo>` **(** **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_method_is_pressed>` **(** **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shortcut_match<class_InputEvent_method_shortcut_match>` **(** :ref:`InputEvent<class_InputEvent>` event **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InputEvent<class_InputEvent>` | :ref:`xformed_by<class_InputEvent_method_xformed_by>` **(** :ref:`Transform2D<class_Transform2D>` xform, :ref:`Vector2<class_Vector2>` local_ofs=Vector2( 0, 0 ) **)** |const| |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
@@ -107,34 +107,42 @@ Returns a :ref:`String<class_String>` representation of the event.
.. _class_InputEvent_method_get_action_strength:
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`float<class_float>` **get_action_strength** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const|
Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>`.
If ``exact_match`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_InputEvent_method_is_action:
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const|
Returns ``true`` if this input event matches a pre-defined action of any type.
If ``exact_match`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_InputEvent_method_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` allow_echo=false **)** |const|
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` allow_echo=false, :ref:`bool<class_bool>` exact_match=false **)** |const|
Returns ``true`` if the given action is being pressed (and is not an echo event for :ref:`InputEventKey<class_InputEventKey>` events, unless ``allow_echo`` is ``true``). Not relevant for events of type :ref:`InputEventMouseMotion<class_InputEventMouseMotion>` or :ref:`InputEventScreenDrag<class_InputEventScreenDrag>`.
If ``exact_match`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_InputEvent_method_is_action_released:
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const|
Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for events of type :ref:`InputEventMouseMotion<class_InputEventMouseMotion>` or :ref:`InputEventScreenDrag<class_InputEventScreenDrag>`.
If ``exact_match`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_InputEvent_method_is_action_type:
classes/class_inputeventaction.rst
+2 -2
View File
@@ -23,9 +23,9 @@ Tutorials
- `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_inputeventmousemotion.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Tutorials
- :doc:`../tutorials/inputs/mouse_and_input_coordinates`
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_inputmap.rst
+30 -28
View File
@@ -26,33 +26,33 @@ Tutorials
Methods
-------
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_method_action_add_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_method_action_erase_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_method_action_erase_events>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`action_get_deadzone<class_InputMap_method_action_get_deadzone>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_method_action_has_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_set_deadzone<class_InputMap_method_action_set_deadzone>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_method_add_action>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_method_erase_action>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_method_event_is_action>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** |const| |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_method_get_action_list>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_method_get_actions>` **(** **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_method_has_action>` **(** :ref:`String<class_String>` action **)** |const| |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_method_load_from_globals>` **(** **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_method_action_add_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_method_action_erase_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_events<class_InputMap_method_action_erase_events>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`action_get_deadzone<class_InputMap_method_action_get_deadzone>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_method_action_has_event>` **(** :ref:`String<class_String>` action, :ref:`InputEvent<class_InputEvent>` event **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_set_deadzone<class_InputMap_method_action_set_deadzone>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_method_add_action>` **(** :ref:`String<class_String>` action, :ref:`float<class_float>` deadzone=0.5 **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_method_erase_action>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_method_event_is_action>` **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_action_list<class_InputMap_method_get_action_list>` **(** :ref:`String<class_String>` action **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_actions<class_InputMap_method_get_actions>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_method_has_action>` **(** :ref:`String<class_String>` action **)** |const| |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_method_load_from_globals>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
@@ -125,10 +125,12 @@ Removes an action from the ``InputMap``.
.. _class_InputMap_method_event_is_action:
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action **)** |const|
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_InputEvent>` event, :ref:`String<class_String>` action, :ref:`bool<class_bool>` exact_match=false **)** |const|
Returns ``true`` if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_InputEvent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_method_action_has_event>` if you don't want this behavior.
If ``exact_match`` is ``false``, it ignores the input modifiers for :ref:`InputEventKey<class_InputEventKey>` and :ref:`InputEventMouseButton<class_InputEventMouseButton>` events, and the direction for :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>` events.
----
.. _class_InputMap_method_get_action_list:
classes/class_joint.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Joints are used to bind together two physics bodies. They have a solver priority
Tutorials
---------
- `https://godotengine.org/asset-library/asset/524 <https://godotengine.org/asset-library/asset/524>`_
- `3D Truck Town Demo <https://godotengine.org/asset-library/asset/524>`_
Properties
----------
classes/class_kinematicbody.rst
+4 -4
View File
@@ -27,13 +27,13 @@ Tutorials
- :doc:`../tutorials/physics/kinematic_character_2d`
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_kinematicbody2d.rst
+2 -2
View File
@@ -29,9 +29,9 @@ Tutorials
- :doc:`../tutorials/physics/using_kinematic_body_2d`
- `https://godotengine.org/asset-library/asset/113 <https://godotengine.org/asset-library/asset/113>`_
- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`_
- `https://godotengine.org/asset-library/asset/120 <https://godotengine.org/asset-library/asset/120>`_
- `2D Platformer Demo <https://godotengine.org/asset-library/asset/120>`_
Properties
----------
classes/class_label.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Label displays plain text on the screen. It gives you control over the horizonta
Tutorials
---------
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
Properties
----------
classes/class_light.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Tutorials
- :doc:`../tutorials/3d/lights_and_shadows`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_line2d.rst
+2 -2
View File
@@ -23,9 +23,9 @@ A line through several points in 2D space.
Tutorials
---------
- `https://godotengine.org/asset-library/asset/584 <https://godotengine.org/asset-library/asset/584>`_
- `Matrix Transform Demo <https://godotengine.org/asset-library/asset/584>`_
- `https://godotengine.org/asset-library/asset/583 <https://godotengine.org/asset-library/asset/583>`_
- `2.5D Demo <https://godotengine.org/asset-library/asset/583>`_
Properties
----------
classes/class_material.rst
+2 -2
View File
@@ -23,9 +23,9 @@ Material is a base :ref:`Resource<class_Resource>` used for coloring and shading
Tutorials
---------
- `https://godotengine.org/asset-library/asset/123 <https://godotengine.org/asset-library/asset/123>`_
- `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_mesh.rst
+9 -5
View File
@@ -23,13 +23,13 @@ Mesh is a type of :ref:`Resource<class_Resource>` that contains vertex array-bas
Tutorials
---------
- `https://godotengine.org/asset-library/asset/123 <https://godotengine.org/asset-library/asset/123>`_
- `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`_
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
@@ -160,6 +160,8 @@ enum **BlendShapeMode**:
.. _class_Mesh_constant_ARRAY_FLAG_USE_16_BIT_BONES:
.. _class_Mesh_constant_ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION:
.. _class_Mesh_constant_ARRAY_COMPRESS_DEFAULT:
enum **ArrayFormat**:
@@ -206,7 +208,9 @@ enum **ArrayFormat**:
- **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<class_Mesh_constant_ARRAY_COMPRESS_VERTEX>`, :ref:`ARRAY_COMPRESS_NORMAL<class_Mesh_constant_ARRAY_COMPRESS_NORMAL>`, :ref:`ARRAY_COMPRESS_TANGENT<class_Mesh_constant_ARRAY_COMPRESS_TANGENT>`, :ref:`ARRAY_COMPRESS_COLOR<class_Mesh_constant_ARRAY_COMPRESS_COLOR>`, :ref:`ARRAY_COMPRESS_TEX_UV<class_Mesh_constant_ARRAY_COMPRESS_TEX_UV>`, :ref:`ARRAY_COMPRESS_TEX_UV2<class_Mesh_constant_ARRAY_COMPRESS_TEX_UV2>` and :ref:`ARRAY_COMPRESS_WEIGHTS<class_Mesh_constant_ARRAY_COMPRESS_WEIGHTS>` quickly.
- **ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION** = **2097152** --- Flag used to mark that the array uses an octahedral representation of normal and tangent vectors rather than cartesian.
- **ARRAY_COMPRESS_DEFAULT** = **2194432** --- Used to set flags :ref:`ARRAY_COMPRESS_VERTEX<class_Mesh_constant_ARRAY_COMPRESS_VERTEX>`, :ref:`ARRAY_COMPRESS_NORMAL<class_Mesh_constant_ARRAY_COMPRESS_NORMAL>`, :ref:`ARRAY_COMPRESS_TANGENT<class_Mesh_constant_ARRAY_COMPRESS_TANGENT>`, :ref:`ARRAY_COMPRESS_COLOR<class_Mesh_constant_ARRAY_COMPRESS_COLOR>`, :ref:`ARRAY_COMPRESS_TEX_UV<class_Mesh_constant_ARRAY_COMPRESS_TEX_UV>`, :ref:`ARRAY_COMPRESS_TEX_UV2<class_Mesh_constant_ARRAY_COMPRESS_TEX_UV2>`, :ref:`ARRAY_COMPRESS_WEIGHTS<class_Mesh_constant_ARRAY_COMPRESS_WEIGHTS>`, and :ref:`ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION<class_Mesh_constant_ARRAY_FLAG_USE_OCTAHEDRAL_COMPRESSION>` quickly.
----
classes/class_meshinstance.rst
+4 -4
View File
@@ -23,13 +23,13 @@ MeshInstance is a node that takes a :ref:`Mesh<class_Mesh>` resource and adds it
Tutorials
---------
- `https://godotengine.org/asset-library/asset/123 <https://godotengine.org/asset-library/asset/123>`_
- `3D Material Testers Demo <https://godotengine.org/asset-library/asset/123>`_
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_meshlibrary.rst
+2 -2
View File
@@ -21,9 +21,9 @@ A library of meshes. Contains a list of :ref:`Mesh<class_Mesh>` resources, each
Tutorials
---------
- `https://godotengine.org/asset-library/asset/126 <https://godotengine.org/asset-library/asset/126>`_
- `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
Methods
-------
classes/class_navigation.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Provides navigation and pathfinding within a collection of :ref:`NavigationMesh<
Tutorials
---------
- `https://godotengine.org/asset-library/asset/124 <https://godotengine.org/asset-library/asset/124>`_
- `3D Navmesh Demo <https://godotengine.org/asset-library/asset/124>`_
Properties
----------
classes/class_navigation2d.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Navigation2D provides navigation and pathfinding within a 2D area, specified as
Tutorials
---------
- `https://godotengine.org/asset-library/asset/117 <https://godotengine.org/asset-library/asset/117>`_
- `2D Navigation Demo <https://godotengine.org/asset-library/asset/117>`_
Methods
-------
classes/class_navigationmesh.rst
+1 -1
View File
@@ -16,7 +16,7 @@ NavigationMesh
Tutorials
---------
- `https://godotengine.org/asset-library/asset/124 <https://godotengine.org/asset-library/asset/124>`_
- `3D Navmesh Demo <https://godotengine.org/asset-library/asset/124>`_
Properties
----------
classes/class_navigationpolygon.rst
+1 -1
View File
@@ -42,7 +42,7 @@ Using :ref:`add_polygon<class_NavigationPolygon_method_add_polygon>` and indices
Tutorials
---------
- `https://godotengine.org/asset-library/asset/117 <https://godotengine.org/asset-library/asset/117>`_
- `2D Navigation Demo <https://godotengine.org/asset-library/asset/117>`_
Methods
-------
classes/class_networkedmultiplayerpeer.rst
+1 -1
View File
@@ -27,7 +27,7 @@ Tutorials
- :doc:`../tutorials/networking/high_level_multiplayer`
- `https://godotengine.org/asset-library/asset/537 <https://godotengine.org/asset-library/asset/537>`_
- `WebRTC Signaling Demo <https://godotengine.org/asset-library/asset/537>`_
Properties
----------
classes/class_node.rst
+1 -1
View File
@@ -45,7 +45,7 @@ Tutorials
- :doc:`../getting_started/step_by_step/scenes_and_nodes`
- `https://github.com/godotengine/godot-demo-projects/ <https://github.com/godotengine/godot-demo-projects/>`_
- `All Demos <https://github.com/godotengine/godot-demo-projects/>`_
Properties
----------
classes/class_node2d.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Tutorials
- :doc:`../tutorials/2d/custom_drawing_in_2d`
- `https://github.com/godotengine/godot-demo-projects/tree/master/2d <https://github.com/godotengine/godot-demo-projects/tree/master/2d>`_
- `All 2D Demos <https://github.com/godotengine/godot-demo-projects/tree/master/2d>`_
Properties
----------
classes/class_nodepath.rst
+1 -1
View File
@@ -40,7 +40,7 @@ Some examples of NodePaths include the following:
Tutorials
---------
- `https://godotengine.org/asset-library/asset/520 <https://godotengine.org/asset-library/asset/520>`_
- `2D Role Playing Game Demo <https://godotengine.org/asset-library/asset/520>`_
Methods
-------
classes/class_os.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Operating System functions. OS wraps the most common functionality to communicat
Tutorials
---------
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Properties
----------
classes/class_packedscene.rst
+1 -1
View File
@@ -60,7 +60,7 @@ Can be used to save a node to a file. When saving, the node as well as all the n
Tutorials
---------
- `https://godotengine.org/asset-library/asset/520 <https://godotengine.org/asset-library/asset/520>`_
- `2D Role Playing Game Demo <https://godotengine.org/asset-library/asset/520>`_
Properties
----------
classes/class_panel.rst
+3 -3
View File
@@ -21,11 +21,11 @@ Panel is a :ref:`Control<class_Control>` that displays an opaque background. It'
Tutorials
---------
- `https://godotengine.org/asset-library/asset/520 <https://godotengine.org/asset-library/asset/520>`_
- `2D Role Playing Game Demo <https://godotengine.org/asset-library/asset/520>`_
- `https://godotengine.org/asset-library/asset/516 <https://godotengine.org/asset-library/asset/516>`_
- `2D Finite State Machine Demo <https://godotengine.org/asset-library/asset/516>`_
- `https://godotengine.org/asset-library/asset/523 <https://godotengine.org/asset-library/asset/523>`_
- `3D Inverse Kinematics Demo <https://godotengine.org/asset-library/asset/523>`_
Theme Properties
----------------
classes/class_panelcontainer.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Panel container type. This container fits controls inside of the delimited area
Tutorials
---------
- `https://godotengine.org/asset-library/asset/520 <https://godotengine.org/asset-library/asset/520>`_
- `2D Role Playing Game Demo <https://godotengine.org/asset-library/asset/520>`_
Theme Properties
----------------
classes/class_particles.rst
+1 -1
View File
@@ -29,7 +29,7 @@ Tutorials
- :doc:`../tutorials/3d/vertex_animation/controlling_thousands_of_fish`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_particles2d.rst
+1 -1
View File
@@ -31,7 +31,7 @@ Tutorials
- :doc:`../tutorials/2d/particle_systems_2d`
- `https://godotengine.org/asset-library/asset/515 <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
Properties
----------
classes/class_poolstringarray.rst
+1 -1
View File
@@ -21,7 +21,7 @@ An :ref:`Array<class_Array>` specifically designed to hold :ref:`String<class_St
Tutorials
---------
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Methods
-------
classes/class_poolvector2array.rst
+1 -1
View File
@@ -21,7 +21,7 @@ An :ref:`Array<class_Array>` specifically designed to hold :ref:`Vector2<class_V
Tutorials
---------
- `https://godotengine.org/asset-library/asset/519 <https://godotengine.org/asset-library/asset/519>`_
- `2D Navigation Astar Demo <https://godotengine.org/asset-library/asset/519>`_
Methods
-------
classes/class_projectsettings.rst
+339 -3
View File
@@ -27,11 +27,11 @@ When naming a Project Settings property, use the full path to the setting includ
Tutorials
---------
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
- `https://godotengine.org/asset-library/asset/125 <https://godotengine.org/asset-library/asset/125>`_
- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`_
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Properties
----------
@@ -321,8 +321,32 @@ Properties
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_20<class_ProjectSettings_property_layer_names/2d_physics/layer_20>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_21<class_ProjectSettings_property_layer_names/2d_physics/layer_21>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_22<class_ProjectSettings_property_layer_names/2d_physics/layer_22>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_23<class_ProjectSettings_property_layer_names/2d_physics/layer_23>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_24<class_ProjectSettings_property_layer_names/2d_physics/layer_24>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_25<class_ProjectSettings_property_layer_names/2d_physics/layer_25>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_26<class_ProjectSettings_property_layer_names/2d_physics/layer_26>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_27<class_ProjectSettings_property_layer_names/2d_physics/layer_27>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_28<class_ProjectSettings_property_layer_names/2d_physics/layer_28>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_29<class_ProjectSettings_property_layer_names/2d_physics/layer_29>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_3<class_ProjectSettings_property_layer_names/2d_physics/layer_3>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_30<class_ProjectSettings_property_layer_names/2d_physics/layer_30>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_31<class_ProjectSettings_property_layer_names/2d_physics/layer_31>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_32<class_ProjectSettings_property_layer_names/2d_physics/layer_32>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_4<class_ProjectSettings_property_layer_names/2d_physics/layer_4>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/2d_physics/layer_5<class_ProjectSettings_property_layer_names/2d_physics/layer_5>` | ``""`` |
@@ -401,8 +425,32 @@ Properties
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_20<class_ProjectSettings_property_layer_names/3d_physics/layer_20>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_21<class_ProjectSettings_property_layer_names/3d_physics/layer_21>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_22<class_ProjectSettings_property_layer_names/3d_physics/layer_22>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_23<class_ProjectSettings_property_layer_names/3d_physics/layer_23>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_24<class_ProjectSettings_property_layer_names/3d_physics/layer_24>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_25<class_ProjectSettings_property_layer_names/3d_physics/layer_25>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_26<class_ProjectSettings_property_layer_names/3d_physics/layer_26>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_27<class_ProjectSettings_property_layer_names/3d_physics/layer_27>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_28<class_ProjectSettings_property_layer_names/3d_physics/layer_28>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_29<class_ProjectSettings_property_layer_names/3d_physics/layer_29>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_3<class_ProjectSettings_property_layer_names/3d_physics/layer_3>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_30<class_ProjectSettings_property_layer_names/3d_physics/layer_30>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_31<class_ProjectSettings_property_layer_names/3d_physics/layer_31>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_32<class_ProjectSettings_property_layer_names/3d_physics/layer_32>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_4<class_ProjectSettings_property_layer_names/3d_physics/layer_4>` | ``""`` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`layer_names/3d_physics/layer_5<class_ProjectSettings_property_layer_names/3d_physics/layer_5>` | ``""`` |
@@ -2520,6 +2568,114 @@ Optional name for the 2D physics layer 20.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_21:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_21**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 21.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_22:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_22**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 22.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_23:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_23**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 23.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_24:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_24**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 24.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_25:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_25**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 25.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_26:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_26**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 26.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_27:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_27**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 27.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_28:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_28**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 28.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_29:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_29**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 29.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_3:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_3**
@@ -2532,6 +2688,42 @@ Optional name for the 2D physics layer 3.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_30:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_30**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 30.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_31:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_31**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 31.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_32:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_32**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 2D physics layer 32.
----
.. _class_ProjectSettings_property_layer_names/2d_physics/layer_4:
- :ref:`String<class_String>` **layer_names/2d_physics/layer_4**
@@ -3000,6 +3192,114 @@ Optional name for the 3D physics layer 20.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_21:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_21**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 21.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_22:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_22**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 22.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_23:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_23**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 23.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_24:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_24**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 24.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_25:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_25**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 25.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_26:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_26**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 26.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_27:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_27**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 27.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_28:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_28**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 28.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_29:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_29**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 29.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_3:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_3**
@@ -3012,6 +3312,42 @@ Optional name for the 3D physics layer 3.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_30:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_30**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 30.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_31:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_31**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 31.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_32:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_32**
+-----------+--------+
| *Default* | ``""`` |
+-----------+--------+
Optional name for the 3D physics layer 32.
----
.. _class_ProjectSettings_property_layer_names/3d_physics/layer_4:
- :ref:`String<class_String>` **layer_names/3d_physics/layer_4**
classes/class_quadmesh.rst
+2 -2
View File
@@ -21,9 +21,9 @@ Class representing a square :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat
Tutorials
---------
- `https://godotengine.org/asset-library/asset/127 <https://godotengine.org/asset-library/asset/127>`_
- `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`_
- `https://godotengine.org/asset-library/asset/129 <https://godotengine.org/asset-library/asset/129>`_
- `2D in 3D Demo <https://godotengine.org/asset-library/asset/129>`_
Properties
----------
classes/class_quat.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Tutorials
- `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms`
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Properties
----------
classes/class_randomnumbergenerator.rst
+5
View File
@@ -31,6 +31,11 @@ To generate a random float number (within a given range) based on a time-dependa
**Note:** The default values of :ref:`seed<class_RandomNumberGenerator_property_seed>` and :ref:`state<class_RandomNumberGenerator_property_state>` properties are pseudo-random, and changes when calling :ref:`randomize<class_RandomNumberGenerator_method_randomize>`. The ``0`` value documented here is a placeholder, and not the actual default seed.
Tutorials
---------
- :doc:`../tutorials/math/random_number_generation`
Properties
----------
classes/class_raycast.rst
+1 -1
View File
@@ -31,7 +31,7 @@ Tutorials
- :doc:`../tutorials/physics/ray-casting`
- `https://godotengine.org/asset-library/asset/676 <https://godotengine.org/asset-library/asset/676>`_
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`_
Properties
----------
classes/class_rectangleshape2d.rst
+2 -2
View File
@@ -21,9 +21,9 @@ Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D
Tutorials
---------
- `https://godotengine.org/asset-library/asset/121 <https://godotengine.org/asset-library/asset/121>`_
- `2D Pong Demo <https://godotengine.org/asset-library/asset/121>`_
- `https://godotengine.org/asset-library/asset/113 <https://godotengine.org/asset-library/asset/113>`_
- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`_
Properties
----------
classes/class_resourceloader.rst
+1 -1
View File
@@ -23,7 +23,7 @@ It uses the many :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` classes
Tutorials
---------
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Methods
-------
classes/class_richtextlabel.rst
+2 -2
View File
@@ -29,9 +29,9 @@ Tutorials
- :doc:`../tutorials/gui/bbcode_in_richtextlabel`
- `https://godotengine.org/asset-library/asset/132 <https://godotengine.org/asset-library/asset/132>`_
- `GUI Rich Text/BBcode Demo <https://godotengine.org/asset-library/asset/132>`_
- `https://godotengine.org/asset-library/asset/677 <https://godotengine.org/asset-library/asset/677>`_
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`_
Properties
----------
classes/class_rigidbody.rst
+2 -2
View File
@@ -33,9 +33,9 @@ Tutorials
- :doc:`../tutorials/physics/physics_introduction`
- `https://godotengine.org/asset-library/asset/524 <https://godotengine.org/asset-library/asset/524>`_
- `3D Truck Town Demo <https://godotengine.org/asset-library/asset/524>`_
- `https://godotengine.org/asset-library/asset/675 <https://godotengine.org/asset-library/asset/675>`_
- `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`_
Properties
----------
classes/class_rigidbody2d.rst
+2 -2
View File
@@ -31,9 +31,9 @@ The center of mass is always located at the node's origin without taking into ac
Tutorials
---------
- `https://godotengine.org/asset-library/asset/119 <https://godotengine.org/asset-library/asset/119>`_
- `2D Physics Platformer Demo <https://godotengine.org/asset-library/asset/119>`_
- `https://godotengine.org/asset-library/asset/148 <https://godotengine.org/asset-library/asset/148>`_
- `Instancing Demo <https://godotengine.org/asset-library/asset/148>`_
Properties
----------
classes/class_skeleton.rst
+2 -2
View File
@@ -25,9 +25,9 @@ Note that "global pose" below refers to the overall transform of the bone with r
Tutorials
---------
- `https://godotengine.org/asset-library/asset/523 <https://godotengine.org/asset-library/asset/523>`_
- `3D Inverse Kinematics Demo <https://godotengine.org/asset-library/asset/523>`_
- `https://godotengine.org/asset-library/asset/678 <https://godotengine.org/asset-library/asset/678>`_
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`_
Methods
-------
classes/class_skeletonik.rst
+1 -1
View File
@@ -41,7 +41,7 @@ SkeletonIK is used to place the end bone of a :ref:`Skeleton<class_Skeleton>` bo
Tutorials
---------
- `https://godotengine.org/asset-library/asset/523 <https://godotengine.org/asset-library/asset/523>`_
- `3D Inverse Kinematics Demo <https://godotengine.org/asset-library/asset/523>`_
Properties
----------
classes/class_spatial.rst
+1 -1
View File
@@ -29,7 +29,7 @@ Tutorials
- :doc:`../tutorials/3d/introduction_to_3d`
- `https://github.com/godotengine/godot-demo-projects/tree/master/3d <https://github.com/godotengine/godot-demo-projects/tree/master/3d>`_
- `All 3D Demos <https://github.com/godotengine/godot-demo-projects/tree/master/3d>`_
Properties
----------

Some files were not shown because too many files have changed in this diff Show More