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

Sync classref again after https://github.com/godotengine/godot/pull/15611

Browse Source
This commit is contained in:
Rémi Verschelde
2018-01-12 09:04:12 +01:00
parent 4548bb71d5
commit b85627507e
71 changed files with 1295 additions and 3354 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_@globalscope.rst
+1 -1
View File
@@ -185,7 +185,7 @@ enum **PropertyUsageFlags**
- **PROPERTY_USAGE_SCRIPT_VARIABLE** = **8192**
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
- **PROPERTY_USAGE_DEFAULT_INTL** = **71**
- **PROPERTY_USAGE_NOEDITOR** = **1048581**
- **PROPERTY_USAGE_NOEDITOR** = **5**
.. _enum_@GlobalScope_JoystickList:
classes/class_animation.rst
+16 -48
View File
@@ -28,14 +28,8 @@ Member Functions
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
@@ -44,12 +38,6 @@ Member Functions
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
@@ -107,6 +95,22 @@ Member Functions
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Animation_length:
- :ref:`float<class_float>` **length** - The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
.. _class_Animation_loop:
- :ref:`bool<class_bool>` **loop** - A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
.. _class_Animation_step:
- :ref:`float<class_float>` **step** - The animation step value.
Enums
-----
@@ -169,30 +173,12 @@ Adds a new track that is a copy of the given track from ``to_animation``.
Return the index of the specified track. If the track is not found, return -1.
.. _class_Animation_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
Return the total length of the animation (in seconds).
.. _class_Animation_get_step:
- :ref:`float<class_float>` **get_step** **(** **)** const
Get the animation step value.
.. _class_Animation_get_track_count:
- :ref:`int<class_int>` **get_track_count** **(** **)** const
Return the amount of tracks in the animation.
.. _class_Animation_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Return whether the animation has the loop flag set.
.. _class_Animation_method_track_get_key_indices:
- :ref:`PoolIntArray<class_poolintarray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
@@ -217,24 +203,6 @@ Return the arguments values to be called on a method track for a given key in a
Remove a track by specifying the track index.
.. _class_Animation_set_length:
- void **set_length** **(** :ref:`float<class_float>` time_sec **)**
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
.. _class_Animation_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
.. _class_Animation_set_step:
- void **set_step** **(** :ref:`float<class_float>` size_sec **)**
Set the animation step value.
.. _class_Animation_track_find_key:
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const
classes/class_animationplayer.rst
+24 -80
View File
@@ -38,22 +38,10 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_position<class_AnimationPlayer_get_current_animation_position>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
@@ -68,16 +56,8 @@ Member Functions
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -106,6 +86,26 @@ Notifies when an animation starts playing.
Member Variables
----------------
.. _class_AnimationPlayer_autoplay:
- :ref:`String<class_string>` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``.
.. _class_AnimationPlayer_current_animation:
- :ref:`String<class_string>` **current_animation** - The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play<class_AnimationPlayer_play>`. Default value: ``""``.
.. _class_AnimationPlayer_current_animation_length:
- :ref:`float<class_float>` **current_animation_length** - The length (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_current_animation_position:
- :ref:`float<class_float>` **current_animation_position** - The position (in seconds) of the currently playing animation.
.. _class_AnimationPlayer_playback_active:
- :ref:`bool<class_bool>` **playback_active** - If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
.. _class_AnimationPlayer_playback_default_blend_time:
- :ref:`float<class_float>` **playback_default_blend_time** - The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``.
@@ -114,6 +114,10 @@ Member Variables
- :ref:`AnimationProcessMode<enum_animationplayer_animationprocessmode>` **playback_process_mode** - The process notification in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
.. _class_AnimationPlayer_playback_speed:
- :ref:`float<class_float>` **playback_speed** - The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``.
.. _class_AnimationPlayer_root_node:
- :ref:`NodePath<class_nodepath>` **root_node** - The node from which node path references will travel. Default value: ``".."``.
@@ -192,54 +196,18 @@ Returns the :ref:`Animation<class_animation>` with key ``name`` or ``null`` if n
Returns the list of stored animation names.
.. _class_AnimationPlayer_get_autoplay:
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
Returns the name of the animation that will be automatically played when the scene is loaded.
.. _class_AnimationPlayer_get_blend_time:
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const
Get the blend time (in seconds) between two animations, referenced by their names.
.. _class_AnimationPlayer_get_current_animation:
- :ref:`String<class_string>` **get_current_animation** **(** **)** const
Returns the name of the animation being played.
.. _class_AnimationPlayer_get_current_animation_length:
- :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
Get the length (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_get_current_animation_position:
- :ref:`float<class_float>` **get_current_animation_position** **(** **)** const
Get the position (in seconds) of the currently playing animation.
.. _class_AnimationPlayer_get_speed_scale:
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
Returns the speed scaling ratio of the current animation channel. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed.
.. _class_AnimationPlayer_has_animation:
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_animation>` with key ``name``.
.. _class_AnimationPlayer_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
Returns ``true`` if the player is active.
.. _class_AnimationPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
@@ -284,36 +252,12 @@ Rename an existing animation with key ``name`` to ``newname``.
Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time.
.. _class_AnimationPlayer_set_active:
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
Sets the player as active (playing). If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
.. _class_AnimationPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
Defines the name of the animation to play when the scene loads. Default value: ``""``.
.. _class_AnimationPlayer_set_blend_time:
- void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
Specify a blend time (in seconds) between two animations, referenced by their names.
.. _class_AnimationPlayer_set_current_animation:
- void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
Sets the name of the current animation. If already playing, restarts the animation. Ensure :ref:`active<class_AnimationPlayer_active>` is ``true`` to simulate :ref:`play<class_AnimationPlayer_play>`. Default value: ``""``.
.. _class_AnimationPlayer_set_speed_scale:
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: ``1``.
.. _class_AnimationPlayer_stop:
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
classes/class_arraymesh.rst
+12 -24
View File
@@ -30,20 +30,12 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_mode<class_ArrayMesh_get_blend_shape_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`AABB<class_aabb>` aabb **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
@@ -69,6 +61,18 @@ Member Functions
| void | :ref:`surface_update_region<class_ArrayMesh_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_ArrayMesh_blend_shape_mode:
- :ref:`BlendShapeMode<enum_mesh_blendshapemode>` **blend_shape_mode**
.. _class_ArrayMesh_custom_aabb:
- :ref:`AABB<class_aabb>` **custom_aabb**
Numeric Constants
-----------------
@@ -135,18 +139,10 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
.. _class_ArrayMesh_get_blend_shape_mode:
- :ref:`int<class_int>` **get_blend_shape_mode** **(** **)** const
.. _class_ArrayMesh_get_blend_shape_name:
- :ref:`String<class_string>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
.. _class_ArrayMesh_get_custom_aabb:
- :ref:`AABB<class_aabb>` **get_custom_aabb** **(** **)** const
.. _class_ArrayMesh_get_surface_count:
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
@@ -157,14 +153,6 @@ Return the amount of surfaces that the ``ArrayMesh`` holds.
- void **regen_normalmaps** **(** **)**
.. _class_ArrayMesh_set_blend_shape_mode:
- void **set_blend_shape_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_ArrayMesh_set_custom_aabb:
- void **set_custom_aabb** **(** :ref:`AABB<class_aabb>` aabb **)**
.. _class_ArrayMesh_surface_get_array_index_len:
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
classes/class_audioeffectreverb.rst
-21
View File
@@ -18,15 +18,6 @@ Adds a Reverb audio effect to an Audio bus.
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_predelay_feedback<class_AudioEffectReverb_get_predelay_feedback>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_predelay_feedback<class_AudioEffectReverb_set_predelay_feedback>` **(** :ref:`float<class_float>` feedback **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -68,15 +59,3 @@ Description
Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
Member Function Description
---------------------------
.. _class_AudioEffectReverb_get_predelay_feedback:
- :ref:`float<class_float>` **get_predelay_feedback** **(** **)** const
.. _class_AudioEffectReverb_set_predelay_feedback:
- void **set_predelay_feedback** **(** :ref:`float<class_float>` feedback **)**
classes/class_audiostreamoggvorbis.rst
+9 -42
View File
@@ -16,53 +16,20 @@ Brief Description
OGG Vorbis audio stream driver.
Member Functions
Member Variables
----------------
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_loop_offset<class_AudioStreamOGGVorbis_get_loop_offset>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_AudioStreamOGGVorbis_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamOGGVorbis_set_loop>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop_offset<class_AudioStreamOGGVorbis_set_loop_offset>` **(** :ref:`float<class_float>` seconds **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
.. _class_AudioStreamOGGVorbis_loop:
- :ref:`bool<class_bool>` **loop**
.. _class_AudioStreamOGGVorbis_loop_offset:
- :ref:`float<class_float>` **loop_offset**
Description
-----------
OGG Vorbis audio stream driver.
Member Function Description
---------------------------
.. _class_AudioStreamOGGVorbis_get_data:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
.. _class_AudioStreamOGGVorbis_get_loop_offset:
- :ref:`float<class_float>` **get_loop_offset** **(** **)** const
.. _class_AudioStreamOGGVorbis_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamOGGVorbis_set_data:
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
.. _class_AudioStreamOGGVorbis_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**
.. _class_AudioStreamOGGVorbis_set_loop_offset:
- void **set_loop_offset** **(** :ref:`float<class_float>` seconds **)**
classes/class_audiostreamsample.rst
-21
View File
@@ -16,15 +16,6 @@ Brief Description
Plays audio.
Member Functions
----------------
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamSample_get_data>` **(** **)** const |
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_AudioStreamSample_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -78,15 +69,3 @@ Description
Plays audio, can loop.
Member Function Description
---------------------------
.. _class_AudioStreamSample_get_data:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
.. _class_AudioStreamSample_set_data:
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
classes/class_bakedlightmapdata.rst
+27 -59
View File
@@ -19,41 +19,41 @@ Brief Description
Member Functions
----------------
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_user<class_BakedLightmapData_add_user>` **(** :ref:`NodePath<class_nodepath>` path, :ref:`Texture<class_texture>` lightmap, :ref:`int<class_int>` instance **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_users<class_BakedLightmapData_clear_users>` **(** **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_bounds<class_BakedLightmapData_get_bounds>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_cell_space_transform<class_BakedLightmapData_get_cell_space_transform>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_subdiv<class_BakedLightmapData_get_cell_subdiv>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_octree<class_BakedLightmapData_get_octree>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_get_user_count>` **(** **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_user_path<class_BakedLightmapData_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bounds<class_BakedLightmapData_set_bounds>` **(** :ref:`AABB<class_aabb>` bounds **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_space_transform<class_BakedLightmapData_set_cell_space_transform>` **(** :ref:`Transform<class_transform>` xform **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_subdiv<class_BakedLightmapData_set_cell_subdiv>` **(** :ref:`int<class_int>` cell_subdiv **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octree<class_BakedLightmapData_set_octree>` **(** :ref:`PoolByteArray<class_poolbytearray>` octree **)** |
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_user<class_BakedLightmapData_add_user>` **(** :ref:`NodePath<class_nodepath>` path, :ref:`Texture<class_texture>` lightmap, :ref:`int<class_int>` instance **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_users<class_BakedLightmapData_clear_users>` **(** **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_get_user_count>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_user_path<class_BakedLightmapData_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_BakedLightmapData_bounds:
- :ref:`AABB<class_aabb>` **bounds**
.. _class_BakedLightmapData_cell_space_transform:
- :ref:`Transform<class_transform>` **cell_space_transform**
.. _class_BakedLightmapData_cell_subdiv:
- :ref:`int<class_int>` **cell_subdiv**
.. _class_BakedLightmapData_energy:
- :ref:`float<class_float>` **energy**
.. _class_BakedLightmapData_octree:
- :ref:`PoolByteArray<class_poolbytearray>` **octree**
Member Function Description
---------------------------
@@ -66,22 +66,6 @@ Member Function Description
- void **clear_users** **(** **)**
.. _class_BakedLightmapData_get_bounds:
- :ref:`AABB<class_aabb>` **get_bounds** **(** **)** const
.. _class_BakedLightmapData_get_cell_space_transform:
- :ref:`Transform<class_transform>` **get_cell_space_transform** **(** **)** const
.. _class_BakedLightmapData_get_cell_subdiv:
- :ref:`int<class_int>` **get_cell_subdiv** **(** **)** const
.. _class_BakedLightmapData_get_octree:
- :ref:`PoolByteArray<class_poolbytearray>` **get_octree** **(** **)** const
.. _class_BakedLightmapData_get_user_count:
- :ref:`int<class_int>` **get_user_count** **(** **)** const
@@ -94,20 +78,4 @@ Member Function Description
- :ref:`NodePath<class_nodepath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const
.. _class_BakedLightmapData_set_bounds:
- void **set_bounds** **(** :ref:`AABB<class_aabb>` bounds **)**
.. _class_BakedLightmapData_set_cell_space_transform:
- void **set_cell_space_transform** **(** :ref:`Transform<class_transform>` xform **)**
.. _class_BakedLightmapData_set_cell_subdiv:
- void **set_cell_subdiv** **(** :ref:`int<class_int>` cell_subdiv **)**
.. _class_BakedLightmapData_set_octree:
- void **set_octree** **(** :ref:`PoolByteArray<class_poolbytearray>` octree **)**
classes/class_boneattachment.rst
+5 -22
View File
@@ -16,33 +16,16 @@ Brief Description
A node that will attach to a bone.
Member Functions
Member Variables
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_bone_name<class_BoneAttachment_get_bone_name>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bone_name<class_BoneAttachment_set_bone_name>` **(** :ref:`String<class_string>` bone_name **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------+
.. _class_BoneAttachment_bone_name:
- :ref:`String<class_string>` **bone_name** - The name of the attached bone.
Description
-----------
This node must be the child of a :ref:`Skeleton<class_skeleton>` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.
Member Function Description
---------------------------
.. _class_BoneAttachment_get_bone_name:
- :ref:`String<class_string>` **get_bone_name** **(** **)** const
Returns the name of the bone node attached to.
.. _class_BoneAttachment_set_bone_name:
- void **set_bone_name** **(** :ref:`String<class_string>` bone_name **)**
Changes the name of the bone node
classes/class_camera2d.rst
+27 -63
View File
@@ -19,33 +19,21 @@ Camera node for 2D scenes.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
+--------------------------------+--------------------------------------------------------------------------------------------+
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------+
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------+
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -58,6 +46,10 @@ Member Variables
- :ref:`bool<class_bool>` **current** - If ``true`` the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one.
.. _class_Camera2D_custom_viewport:
- :ref:`Node<class_node>` **custom_viewport** - The custom :ref:`Viewport<class_viewport>` node attached to the ``Camera2D``. If null or not a :ref:`Viewport<class_viewport>`, uses the default viewport instead.
.. _class_Camera2D_drag_margin_bottom:
- :ref:`float<class_float>` **drag_margin_bottom** - Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.
@@ -118,6 +110,14 @@ Member Variables
- :ref:`Vector2<class_vector2>` **offset** - The camera's offset, useful for looking around or camera shake animations.
.. _class_Camera2D_offset_h:
- :ref:`float<class_float>` **offset_h** - The horizontal offset of the camera, relative to the drag margins. Default value: ``0``
.. _class_Camera2D_offset_v:
- :ref:`float<class_float>` **offset_v** - The vertical offset of the camera, relative to the drag margins. Default value: ``0``
.. _class_Camera2D_rotating:
- :ref:`bool<class_bool>` **rotating** - If ``true`` the camera rotates with the target. Default value: ``false``
@@ -186,24 +186,6 @@ Return the camera position.
Returns the location of the ``Camera2D``'s screen-center, relative to the origin.
.. _class_Camera2D_get_custom_viewport:
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
Returns the :ref:`Viewport<class_viewport>` used by the camera if it is not using the default viewport.
.. _class_Camera2D_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
Returns the horizontal offset of the camera.
.. _class_Camera2D_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
Returns the vertical offset of the camera.
.. _class_Camera2D_make_current:
- void **make_current** **(** **)**
@@ -218,22 +200,4 @@ Set the camera's position immediately to its current smoothing destination.
This has no effect if smoothing is disabled.
.. _class_Camera2D_set_custom_viewport:
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
Assigns a custom :ref:`Viewport<class_viewport>` node to the ``Camera2D``. If ``viewport`` is not a :ref:`Viewport<class_viewport>`, it re-assigns the default viewport instead.
.. _class_Camera2D_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
The camera's horizontal offset is set to ``ofs``.
.. _class_Camera2D_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
The camera's vertical offset is set to ``ofs``.
classes/class_canvaslayer.rst
+16 -52
View File
@@ -21,25 +21,17 @@ Canvas drawing layer.
Member Functions
----------------
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------+
Member Variables
----------------
.. _class_CanvasLayer_custom_viewport:
- :ref:`Node<class_node>` **custom_viewport** - The custom :ref:`Viewport<class_viewport>` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead.
.. _class_CanvasLayer_layer:
- :ref:`int<class_int>` **layer** - Layer index for draw order. Lower values are drawn first. Default value: ``1``.
@@ -50,12 +42,20 @@ Member Variables
.. _class_CanvasLayer_rotation:
- :ref:`float<class_float>` **rotation** - The layer's rotation in degrees.
- :ref:`float<class_float>` **rotation** - The layer's rotation in radians.
.. _class_CanvasLayer_rotation_degrees:
- :ref:`float<class_float>` **rotation_degrees** - The layer's rotation in degrees.
.. _class_CanvasLayer_scale:
- :ref:`Vector2<class_vector2>` **scale** - The layer's scale.
.. _class_CanvasLayer_transform:
- :ref:`Transform2D<class_transform2d>` **transform** - The layer's transform.
Description
-----------
@@ -65,46 +65,10 @@ Canvas drawing layer. :ref:`CanvasItem<class_canvasitem>` nodes that are direct
Member Function Description
---------------------------
.. _class_CanvasLayer_get_custom_viewport:
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
Returns the :ref:`Viewport<class_viewport>` used by the camera if it is not using the default viewport.
.. _class_CanvasLayer_get_rotation:
- :ref:`float<class_float>` **get_rotation** **(** **)** const
Return the base rotation for this layer in radians (helper).
.. _class_CanvasLayer_get_transform:
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
Return the base transform for this layer.
.. _class_CanvasLayer_get_world_2d:
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
Return the :ref:`World2D<class_world2d>` used by this layer.
.. _class_CanvasLayer_set_custom_viewport:
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
Assigns a custom :ref:`Viewport<class_viewport>` node to the ``CanvasLayer``. If ``viewport`` is not a :ref:`Viewport<class_viewport>`, it re-assigns the default viewport instead.
.. _class_CanvasLayer_set_rotation:
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
Set the base rotation for this layer in radians (helper).
.. _class_CanvasLayer_set_transform:
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
Set the base transform for this layer.
classes/class_colorpicker.rst
+19 -51
View File
@@ -19,21 +19,9 @@ Color picker control.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPicker_get_pick_color>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_pick_color<class_ColorPicker_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
+-------+---------------------------------------------------------------------------------------------+
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` color **)** |
+-------+---------------------------------------------------------------------------------------------+
Signals
-------
@@ -45,6 +33,22 @@ Signals
Emitted when the color is changed.
Member Variables
----------------
.. _class_ColorPicker_color:
- :ref:`Color<class_color>` **color** - The currently selected color.
.. _class_ColorPicker_edit_alpha:
- :ref:`bool<class_bool>` **edit_alpha** - If ``true``, shows an alpha channel slider (transparency).
.. _class_ColorPicker_raw_mode:
- :ref:`bool<class_bool>` **raw_mode** - If ``true``, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
Description
-----------
@@ -59,40 +63,4 @@ Member Function Description
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
.. _class_ColorPicker_get_pick_color:
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
Gets the current color.
.. _class_ColorPicker_is_editing_alpha:
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
Returns whether the color has transparency or not.
.. _class_ColorPicker_is_raw_mode:
- :ref:`bool<class_bool>` **is_raw_mode** **(** **)** const
Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR).
.. _class_ColorPicker_set_edit_alpha:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
.. _class_ColorPicker_set_pick_color:
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
Select the current color.
.. _class_ColorPicker_set_raw_mode:
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**
Set whether this color picker is using raw mode or not, see :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>`.
classes/class_control.rst
+12 -48
View File
@@ -56,20 +56,14 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_drag_data<class_Control_get_drag_data>` **(** :ref:`Vector2<class_vector2>` position **)** virtual |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_end<class_Control_get_end>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_focus_mode<class_Control_get_focus_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>` | :ref:`get_focus_owner<class_Control_get_focus_owner>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_Control_get_global_position>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Control_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
@@ -130,18 +124,12 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` position **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>` **(** :ref:`Control<class_control>` target **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_preview<class_Control_set_drag_preview>` **(** :ref:`Control<class_control>` control **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_end<class_Control_set_end>` **(** :ref:`Vector2<class_vector2>` position **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_focus_mode<class_Control_set_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margins_preset<class_Control_set_margins_preset>` **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
@@ -228,6 +216,10 @@ Member Variables
- :ref:`float<class_float>` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR\_\*`` constants. Default value: ``ANCHOR_BEGIN``.
.. _class_Control_focus_mode:
- :ref:`FocusMode<enum_control_focusmode>` **focus_mode** - The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
.. _class_Control_focus_neighbour_bottom:
- :ref:`NodePath<class_nodepath>` **focus_neighbour_bottom** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
@@ -284,6 +276,10 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_con
- :ref:`float<class_float>` **margin_top** - Distance between the node's top edge and its parent container, based on :ref:`anchor_top<class_Control_anchor_top>`.
.. _class_Control_mouse_default_cursor_shape:
- :ref:`CursorShape<enum_control_cursorshape>` **mouse_default_cursor_shape** - The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
.. _class_Control_mouse_filter:
- :ref:`MouseFilter<enum_control_mousefilter>` **mouse_filter** - Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input<class_Control__gui_input>` and how these events should be handled. Use one of the ``MOUSE_FILTER\_\*`` constants. See the constants to learn what each does.
@@ -292,6 +288,10 @@ Margins are often controlled by one or multiple parent :ref:`Container<class_con
- :ref:`bool<class_bool>` **rect_clip_content**
.. _class_Control_rect_global_position:
- :ref:`Vector2<class_vector2>` **rect_global_position** - The node's global position, relative to the world (usually to the top-left corner of the window).
.. _class_Control_rect_min_size:
- :ref:`Vector2<class_vector2>` **rect_min_size** - The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
@@ -550,12 +550,6 @@ Overrides the ``name`` Stylebox in the theme resource the node uses. If ``styleb
Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants.
.. _class_Control_get_default_cursor_shape:
- :ref:`int<class_int>` **get_default_cursor_shape** **(** **)** const
Returns the default cursor shape for this control. See enum ``CURSOR\_\*`` for the list of shapes.
.. _class_Control_get_drag_data:
- :ref:`Object<class_object>` **get_drag_data** **(** :ref:`Vector2<class_vector2>` position **)** virtual
@@ -566,12 +560,6 @@ Returns the default cursor shape for this control. See enum ``CURSOR\_\*`` for t
Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_get_focus_mode:
- :ref:`int<class_int>` **get_focus_mode** **(** **)** const
Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).
.. _class_Control_get_focus_owner:
- :ref:`Control<class_control>` **get_focus_owner** **(** **)** const
@@ -582,12 +570,6 @@ Return which control is owning the keyboard focus, or null if no one.
- :ref:`Font<class_font>` **get_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
.. _class_Control_get_global_position:
- :ref:`Vector2<class_vector2>` **get_global_position** **(** **)** const
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
.. _class_Control_get_global_rect:
- :ref:`Rect2<class_rect2>` **get_global_rect** **(** **)** const
@@ -726,12 +708,6 @@ Give up the focus, no other control will be able to receive keyboard input.
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_set_default_cursor_shape:
- void **set_default_cursor_shape** **(** :ref:`int<class_int>` shape **)**
Sets the default cursor shape for this control. See ``CURSOR\_\*`` for the list of available cursor shapes. Useful for Godot plugins and applications or games that use the system's mouse cursors.
.. _class_Control_set_drag_forwarding:
- void **set_drag_forwarding** **(** :ref:`Control<class_control>` target **)**
@@ -746,18 +722,6 @@ Sets the default cursor shape for this control. See ``CURSOR\_\*`` for the list
Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_set_focus_mode:
- void **set_focus_mode** **(** :ref:`int<class_int>` mode **)**
Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
.. _class_Control_set_global_position:
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` position **)**
Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin<class_Control_set_margin>`).
.. _class_Control_set_margins_preset:
- void **set_margins_preset** **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
classes/class_cubemap.rst
+4 -16
View File
@@ -19,8 +19,6 @@ A CubeMap is a 6 sided 3D texture.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
@@ -28,14 +26,16 @@ Member Functions
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_CubeMap_flags:
- :ref:`int<class_int>` **flags** - The render flags for the ``CubeMap``. See the ``FLAG\_\*`` constants for details.
.. _class_CubeMap_lossy_storage_quality:
- :ref:`float<class_float>` **lossy_storage_quality** - The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY.
@@ -85,12 +85,6 @@ A 6-sided 3D texture typically used for faking reflections. It can be used to ma
Member Function Description
---------------------------
.. _class_CubeMap_get_flags:
- :ref:`int<class_int>` **get_flags** **(** **)** const
Returns the render flags for the ``CubeMap``. See the ``FLAG\_\*`` constants for details.
.. _class_CubeMap_get_height:
- :ref:`int<class_int>` **get_height** **(** **)** const
@@ -109,12 +103,6 @@ Returns an :ref:`Image<class_image>` for a side of the ``CubeMap`` using one of
Returns the ``CubeMap``'s width.
.. _class_CubeMap_set_flags:
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
Returns the render flags for the ``CubeMap``. See the ``FLAG\_\*`` constants for details.
.. _class_CubeMap_set_side:
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
classes/class_engine.rst
+35 -79
View File
@@ -19,37 +19,41 @@ Access to basic engine properties.
Member Functions
----------------
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_Engine_get_frames_drawn>` **(** **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_frames_per_second<class_Engine_get_frames_per_second>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_iterations_per_second<class_Engine_get_iterations_per_second>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MainLoop<class_mainloop>` | :ref:`get_main_loop<class_Engine_get_main_loop>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_singleton<class_Engine_get_singleton>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_target_fps<class_Engine_get_target_fps>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_scale<class_Engine_get_time_scale>` **(** **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_singleton<class_Engine_has_singleton>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editor_hint<class_Engine_is_editor_hint>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_in_physics_frame<class_Engine_is_in_physics_frame>` **(** **)** const |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editor_hint<class_Engine_set_editor_hint>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_iterations_per_second<class_Engine_set_iterations_per_second>` **(** :ref:`int<class_int>` iterations_per_second **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_target_fps<class_Engine_set_target_fps>` **(** :ref:`int<class_int>` target_fps **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_time_scale<class_Engine_set_time_scale>` **(** :ref:`float<class_float>` time_scale **)** |
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_Engine_get_frames_drawn>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_frames_per_second<class_Engine_get_frames_per_second>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`MainLoop<class_mainloop>` | :ref:`get_main_loop<class_Engine_get_main_loop>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_singleton<class_Engine_get_singleton>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_singleton<class_Engine_has_singleton>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_in_physics_frame<class_Engine_is_in_physics_frame>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Engine_editor_hint:
- :ref:`bool<class_bool>` **editor_hint** - If ``true``, it is running inside the editor. Useful for tool scripts.
.. _class_Engine_iterations_per_second:
- :ref:`int<class_int>` **iterations_per_second** - The number of fixed iterations per second (for fixed process and physics).
.. _class_Engine_target_fps:
- :ref:`float<class_float>` **target_fps** - The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
.. _class_Engine_time_scale:
- :ref:`float<class_float>` **time_scale** - Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.
Description
-----------
@@ -71,12 +75,6 @@ Returns the total number of frames drawn.
Returns the frames per second of the running game.
.. _class_Engine_get_iterations_per_second:
- :ref:`int<class_int>` **get_iterations_per_second** **(** **)** const
Returns the number of fixed iterations per second (for fixed process and physics).
.. _class_Engine_get_main_loop:
- :ref:`MainLoop<class_mainloop>` **get_main_loop** **(** **)** const
@@ -87,18 +85,6 @@ Returns the main loop object (see :ref:`MainLoop<class_mainloop>` and :ref:`Scen
- :ref:`Object<class_object>` **get_singleton** **(** :ref:`String<class_string>` name **)** const
.. _class_Engine_get_target_fps:
- :ref:`float<class_float>` **get_target_fps** **(** **)** const
Returns the desired frames per second. If the hardware cannot keep up, this setting may not be respected. It defaults to 0, which indicates no limit.
.. _class_Engine_get_time_scale:
- :ref:`float<class_float>` **get_time_scale** **(** **)**
Returns how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.
.. _class_Engine_get_version_info:
- :ref:`Dictionary<class_dictionary>` **get_version_info** **(** **)** const
@@ -123,40 +109,10 @@ Returns the current engine version information in a Dictionary.
- :ref:`bool<class_bool>` **has_singleton** **(** :ref:`String<class_string>` name **)** const
.. _class_Engine_is_editor_hint:
- :ref:`bool<class_bool>` **is_editor_hint** **(** **)** const
Returns ``true`` if the editor is running.
.. _class_Engine_is_in_physics_frame:
- :ref:`bool<class_bool>` **is_in_physics_frame** **(** **)** const
Returns ``true`` if the game is inside the fixed process and physics phase of the game loop.
.. _class_Engine_set_editor_hint:
- void **set_editor_hint** **(** :ref:`bool<class_bool>` enabled **)**
Sets the running inside the editor hint if ``enabled`` is ``true``.
.. _class_Engine_set_iterations_per_second:
- void **set_iterations_per_second** **(** :ref:`int<class_int>` iterations_per_second **)**
Sets the number of fixed iterations per second (for fixed process and physics).
.. _class_Engine_set_target_fps:
- void **set_target_fps** **(** :ref:`int<class_int>` target_fps **)**
Sets the target frames per second.
.. _class_Engine_set_time_scale:
- void **set_time_scale** **(** :ref:`float<class_float>` time_scale **)**
Sets the time scale.
classes/class_file.rst
+10 -18
View File
@@ -42,8 +42,6 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_double<class_File_get_double>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_endian_swap<class_File_get_endian_swap>` **(** **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_error<class_File_get_error>` **(** **)** const |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
@@ -80,8 +78,6 @@ Member Functions
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_end<class_File_seek_end>` **(** :ref:`int<class_int>` position=0 **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_endian_swap<class_File_set_endian_swap>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_16<class_File_store_16>` **(** :ref:`int<class_int>` value **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_32<class_File_store_32>` **(** :ref:`int<class_int>` value **)** |
@@ -107,6 +103,16 @@ Member Functions
| void | :ref:`store_var<class_File_store_var>` **(** :ref:`Variant<class_variant>` value **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_File_endian_swap:
- :ref:`bool<class_bool>` **endian_swap** - If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.
Note that this is about the file format, not CPU type. This is always reseted to ``false`` whenever you open the file.
Enums
-----
@@ -220,12 +226,6 @@ Returns the next value of the file in CSV (Comma Separated Values) format. You c
Returns the next 64 bits from the file as a floating point number.
.. _class_File_get_endian_swap:
- :ref:`bool<class_bool>` **get_endian_swap** **(** **)**
Returns ``true`` if endian swap is enabled for this file.
.. _class_File_get_error:
- :ref:`int<class_int>` **get_error** **(** **)** const
@@ -334,14 +334,6 @@ Change the file reading/writing cursor to the specified position (in bytes from
Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
.. _class_File_set_endian_swap:
- void **set_endian_swap** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.
Note that this is about the file format, not CPU type. This is always reseted to ``false`` whenever you open the file.
.. _class_File_store_16:
- void **store_16** **(** :ref:`int<class_int>` value **)**
classes/class_filedialog.rst
+23 -59
View File
@@ -19,29 +19,17 @@ Dialog for selecting files or directories in the filesystem.
Member Functions
----------------
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_clear_filters>` **(** **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect_items<class_FileDialog_deselect_items>` **(** **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_FileDialog_get_current_dir>` **(** **)** const |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_file<class_FileDialog_get_current_file>` **(** **)** const |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_path<class_FileDialog_get_current_path>` **(** **)** const |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_dir<class_FileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_file<class_FileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_path<class_FileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_clear_filters>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`deselect_items<class_FileDialog_deselect_items>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------+
Signals
-------
@@ -72,6 +60,18 @@ Member Variables
- :ref:`Access<enum_filedialog_access>` **access**
.. _class_FileDialog_current_dir:
- :ref:`String<class_string>` **current_dir** - The current working directory of the file dialog.
.. _class_FileDialog_current_file:
- :ref:`String<class_string>` **current_file** - The currently selected file of the file dialog.
.. _class_FileDialog_current_path:
- :ref:`String<class_string>` **current_path** - The currently selected file path of the file dialog.
.. _class_FileDialog_filters:
- :ref:`PoolStringArray<class_poolstringarray>` **filters**
@@ -135,24 +135,6 @@ Clear all the added filters in the dialog.
- void **deselect_items** **(** **)**
.. _class_FileDialog_get_current_dir:
- :ref:`String<class_string>` **get_current_dir** **(** **)** const
Get the current working directory of the file dialog.
.. _class_FileDialog_get_current_file:
- :ref:`String<class_string>` **get_current_file** **(** **)** const
Get the current selected file of the file dialog (empty if none).
.. _class_FileDialog_get_current_path:
- :ref:`String<class_string>` **get_current_path** **(** **)** const
Get the current selected path (directory and file) of the file dialog (empty if none).
.. _class_FileDialog_get_vbox:
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
@@ -165,22 +147,4 @@ Return the vertical box container of the dialog, custom controls can be added to
Invalidate and update the current dialog content list.
.. _class_FileDialog_set_current_dir:
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
Set the current working directory of the file dialog.
.. _class_FileDialog_set_current_file:
- void **set_current_file** **(** :ref:`String<class_string>` file **)**
Set the current selected file name of the file dialog.
.. _class_FileDialog_set_current_path:
- void **set_current_path** **(** :ref:`String<class_string>` path **)**
Set the current selected file path of the file dialog.
classes/class_giprobedata.rst
+23 -116
View File
@@ -16,144 +16,51 @@ Brief Description
Member Functions
Member Variables
----------------
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bias<class_GIProbeData_get_bias>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_bounds<class_GIProbeData_get_bounds>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GIProbeData_get_cell_size>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_dynamic_data<class_GIProbeData_get_dynamic_data>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbeData_get_dynamic_range>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_energy<class_GIProbeData_get_energy>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbeData_get_normal_bias>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbeData_get_propagation>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_to_cell_xform<class_GIProbeData_get_to_cell_xform>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbeData_is_compressed>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbeData_is_interior>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bias<class_GIProbeData_set_bias>` **(** :ref:`float<class_float>` bias **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bounds<class_GIProbeData_set_bounds>` **(** :ref:`AABB<class_aabb>` bounds **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GIProbeData_set_cell_size>` **(** :ref:`float<class_float>` cell_size **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_compress<class_GIProbeData_set_compress>` **(** :ref:`bool<class_bool>` compress **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dynamic_data<class_GIProbeData_set_dynamic_data>` **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dynamic_range<class_GIProbeData_set_dynamic_range>` **(** :ref:`int<class_int>` dynamic_range **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy<class_GIProbeData_set_energy>` **(** :ref:`float<class_float>` energy **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_interior<class_GIProbeData_set_interior>` **(** :ref:`bool<class_bool>` interior **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_bias<class_GIProbeData_set_normal_bias>` **(** :ref:`float<class_float>` bias **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_propagation<class_GIProbeData_set_propagation>` **(** :ref:`float<class_float>` propagation **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_to_cell_xform<class_GIProbeData_set_to_cell_xform>` **(** :ref:`Transform<class_transform>` to_cell_xform **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
.. _class_GIProbeData_bias:
Member Function Description
---------------------------
- :ref:`float<class_float>` **bias**
.. _class_GIProbeData_get_bias:
.. _class_GIProbeData_bounds:
- :ref:`float<class_float>` **get_bias** **(** **)** const
- :ref:`AABB<class_aabb>` **bounds**
.. _class_GIProbeData_get_bounds:
.. _class_GIProbeData_cell_size:
- :ref:`AABB<class_aabb>` **get_bounds** **(** **)** const
- :ref:`float<class_float>` **cell_size**
.. _class_GIProbeData_get_cell_size:
.. _class_GIProbeData_compress:
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
- :ref:`bool<class_bool>` **compress**
.. _class_GIProbeData_get_dynamic_data:
.. _class_GIProbeData_dynamic_data:
- :ref:`PoolIntArray<class_poolintarray>` **get_dynamic_data** **(** **)** const
- :ref:`PoolIntArray<class_poolintarray>` **dynamic_data**
.. _class_GIProbeData_get_dynamic_range:
.. _class_GIProbeData_dynamic_range:
- :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
- :ref:`int<class_int>` **dynamic_range**
.. _class_GIProbeData_get_energy:
.. _class_GIProbeData_energy:
- :ref:`float<class_float>` **get_energy** **(** **)** const
- :ref:`float<class_float>` **energy**
.. _class_GIProbeData_get_normal_bias:
.. _class_GIProbeData_interior:
- :ref:`float<class_float>` **get_normal_bias** **(** **)** const
- :ref:`bool<class_bool>` **interior**
.. _class_GIProbeData_get_propagation:
.. _class_GIProbeData_normal_bias:
- :ref:`float<class_float>` **get_propagation** **(** **)** const
- :ref:`float<class_float>` **normal_bias**
.. _class_GIProbeData_get_to_cell_xform:
.. _class_GIProbeData_propagation:
- :ref:`Transform<class_transform>` **get_to_cell_xform** **(** **)** const
- :ref:`float<class_float>` **propagation**
.. _class_GIProbeData_is_compressed:
.. _class_GIProbeData_to_cell_xform:
- :ref:`bool<class_bool>` **is_compressed** **(** **)** const
.. _class_GIProbeData_is_interior:
- :ref:`bool<class_bool>` **is_interior** **(** **)** const
.. _class_GIProbeData_set_bias:
- void **set_bias** **(** :ref:`float<class_float>` bias **)**
.. _class_GIProbeData_set_bounds:
- void **set_bounds** **(** :ref:`AABB<class_aabb>` bounds **)**
.. _class_GIProbeData_set_cell_size:
- void **set_cell_size** **(** :ref:`float<class_float>` cell_size **)**
.. _class_GIProbeData_set_compress:
- void **set_compress** **(** :ref:`bool<class_bool>` compress **)**
.. _class_GIProbeData_set_dynamic_data:
- void **set_dynamic_data** **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)**
.. _class_GIProbeData_set_dynamic_range:
- void **set_dynamic_range** **(** :ref:`int<class_int>` dynamic_range **)**
.. _class_GIProbeData_set_energy:
- void **set_energy** **(** :ref:`float<class_float>` energy **)**
.. _class_GIProbeData_set_interior:
- void **set_interior** **(** :ref:`bool<class_bool>` interior **)**
.. _class_GIProbeData_set_normal_bias:
- void **set_normal_bias** **(** :ref:`float<class_float>` bias **)**
.. _class_GIProbeData_set_propagation:
- void **set_propagation** **(** :ref:`float<class_float>` propagation **)**
.. _class_GIProbeData_set_to_cell_xform:
- void **set_to_cell_xform** **(** :ref:`Transform<class_transform>` to_cell_xform **)**
- :ref:`Transform<class_transform>` **to_cell_xform**
classes/class_graphedit.rst
+35 -81
View File
@@ -19,37 +19,17 @@ GraphEdit is an area capable of showing various GraphNodes. It manages connectio
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_node<class_GraphEdit_connect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_node<class_GraphEdit_disconnect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_connection_list<class_GraphEdit_get_connection_list>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_ofs<class_GraphEdit_get_scroll_ofs>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_snap<class_GraphEdit_get_snap>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_zoom<class_GraphEdit_get_zoom>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_connected<class_GraphEdit_is_node_connected>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_right_disconnects_enabled<class_GraphEdit_is_right_disconnects_enabled>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_snap<class_GraphEdit_is_using_snap>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_right_disconnects<class_GraphEdit_set_right_disconnects>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_ofs<class_GraphEdit_set_scroll_ofs>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Node<class_node>` node **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_snap<class_GraphEdit_set_snap>` **(** :ref:`int<class_int>` pixels **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_snap<class_GraphEdit_set_use_snap>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_zoom<class_GraphEdit_set_zoom>` **(** :ref:`float<class_float>` p_zoom **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_node<class_GraphEdit_connect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_node<class_GraphEdit_disconnect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_connection_list<class_GraphEdit_get_connection_list>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_connected<class_GraphEdit_is_node_connected>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Node<class_node>` node **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -109,6 +89,30 @@ Signal sent when a popup is requested. Happens on right-clicking in the GraphEdi
- **scroll_offset_changed** **(** :ref:`Vector2<class_vector2>` ofs **)**
Member Variables
----------------
.. _class_GraphEdit_right_disconnects:
- :ref:`bool<class_bool>` **right_disconnects** - If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end.
.. _class_GraphEdit_scroll_offset:
- :ref:`Vector2<class_vector2>` **scroll_offset** - The scroll offset.
.. _class_GraphEdit_snap_distance:
- :ref:`int<class_int>` **snap_distance** - The snapping distance in pixels.
.. _class_GraphEdit_use_snap:
- :ref:`bool<class_bool>` **use_snap** - If ``true``, enables snapping.
.. _class_GraphEdit_zoom:
- :ref:`float<class_float>` **zoom** - The current zoom value.
Description
-----------
@@ -137,64 +141,14 @@ Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port'
Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" }
.. _class_GraphEdit_get_scroll_ofs:
- :ref:`Vector2<class_vector2>` **get_scroll_ofs** **(** **)** const
Return the scroll offset.
.. _class_GraphEdit_get_snap:
- :ref:`int<class_int>` **get_snap** **(** **)** const
.. _class_GraphEdit_get_zoom:
- :ref:`float<class_float>` **get_zoom** **(** **)** const
Return the current zoom value.
.. _class_GraphEdit_is_node_connected:
- :ref:`bool<class_bool>` **is_node_connected** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
.. _class_GraphEdit_is_right_disconnects_enabled:
- :ref:`bool<class_bool>` **is_right_disconnects_enabled** **(** **)** const
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
.. _class_GraphEdit_is_using_snap:
- :ref:`bool<class_bool>` **is_using_snap** **(** **)** const
.. _class_GraphEdit_set_right_disconnects:
- void **set_right_disconnects** **(** :ref:`bool<class_bool>` enable **)**
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
.. _class_GraphEdit_set_scroll_ofs:
- void **set_scroll_ofs** **(** :ref:`Vector2<class_vector2>` ofs **)**
.. _class_GraphEdit_set_selected:
- void **set_selected** **(** :ref:`Node<class_node>` node **)**
.. _class_GraphEdit_set_snap:
- void **set_snap** **(** :ref:`int<class_int>` pixels **)**
.. _class_GraphEdit_set_use_snap:
- void **set_use_snap** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GraphEdit_set_zoom:
- void **set_zoom** **(** :ref:`float<class_float>` p_zoom **)**
Set the zoom value of the GraphEdit. Zoom value is between 0.01; 1.728.
classes/class_graphnode.rst
+16 -52
View File
@@ -40,10 +40,6 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_overlay<class_GraphNode_get_overlay>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
@@ -52,22 +48,10 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_right<class_GraphNode_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_comment<class_GraphNode_is_comment>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_GraphNode_is_selected>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_left<class_GraphNode_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_comment<class_GraphNode_set_comment>` **(** :ref:`bool<class_bool>` comment **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_overlay<class_GraphNode_set_overlay>` **(** :ref:`int<class_int>` overlay **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_GraphNode_set_selected>` **(** :ref:`bool<class_bool>` selected **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -106,10 +90,26 @@ Signal sent when the GraphNode is requested to be displayed over other ones. Hap
Member Variables
----------------
.. _class_GraphNode_comment:
- :ref:`bool<class_bool>` **comment**
.. _class_GraphNode_offset:
- :ref:`Vector2<class_vector2>` **offset** - The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit<class_graphedit>`. Note that you cannot use position directly, as :ref:`GraphEdit<class_graphedit>` is a :ref:`Container<class_container>`.
.. _class_GraphNode_overlay:
- :ref:`Overlay<enum_graphnode_overlay>` **overlay**
.. _class_GraphNode_resizable:
- :ref:`bool<class_bool>` **resizable**
.. _class_GraphNode_selected:
- :ref:`bool<class_bool>` **selected**
.. _class_GraphNode_show_close:
- :ref:`bool<class_bool>` **show_close**
@@ -199,16 +199,6 @@ Return the position of the output connection 'idx'.
Return the type of the output connection 'idx'.
.. _class_GraphNode_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the GraphNode.
.. _class_GraphNode_get_overlay:
- :ref:`int<class_int>` **get_overlay** **(** **)** const
.. _class_GraphNode_get_slot_color_left:
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
@@ -233,14 +223,6 @@ Return the (integer) type of left (input) 'idx' slot.
Return the (integer) type of right (output) 'idx' slot.
.. _class_GraphNode_is_comment:
- :ref:`bool<class_bool>` **is_comment** **(** **)** const
.. _class_GraphNode_is_selected:
- :ref:`bool<class_bool>` **is_selected** **(** **)**
.. _class_GraphNode_is_slot_enabled_left:
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
@@ -253,24 +235,6 @@ Return true if left (input) slot 'idx' is enabled. False otherwise.
Return true if right (output) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_set_comment:
- void **set_comment** **(** :ref:`bool<class_bool>` comment **)**
.. _class_GraphNode_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the GraphNode.
.. _class_GraphNode_set_overlay:
- void **set_overlay** **(** :ref:`int<class_int>` overlay **)**
.. _class_GraphNode_set_selected:
- void **set_selected** **(** :ref:`bool<class_bool>` selected **)**
.. _class_GraphNode_set_slot:
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)**
classes/class_gridmap.rst
+65 -133
View File
@@ -19,71 +19,71 @@ Node for 3D tile-based maps.
Member Functions
----------------
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_baked_meshes<class_GridMap_clear_baked_meshes>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_bake_mesh_instance<class_GridMap_get_bake_mesh_instance>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_bake_meshes<class_GridMap_get_bake_meshes>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_GridMap_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_GridMap_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_used_cells<class_GridMap_get_used_cells>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_baked_meshes<class_GridMap_make_baked_meshes>` **(** :ref:`bool<class_bool>` gen_lightmap_uv=false, :ref:`float<class_float>` lightmap_uv_texel_size=0.1 **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`map_to_world<class_GridMap_map_to_world>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_set_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_layer_bit<class_GridMap_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_GridMap_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`world_to_map<class_GridMap_world_to_map>` **(** :ref:`Vector3<class_vector3>` pos **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_baked_meshes<class_GridMap_clear_baked_meshes>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_bake_mesh_instance<class_GridMap_get_bake_mesh_instance>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_bake_meshes<class_GridMap_get_bake_meshes>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_GridMap_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_GridMap_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_used_cells<class_GridMap_get_used_cells>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_baked_meshes<class_GridMap_make_baked_meshes>` **(** :ref:`bool<class_bool>` gen_lightmap_uv=false, :ref:`float<class_float>` lightmap_uv_texel_size=0.1 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`map_to_world<class_GridMap_map_to_world>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_set_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_layer_bit<class_GridMap_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_GridMap_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`world_to_map<class_GridMap_world_to_map>` **(** :ref:`Vector3<class_vector3>` pos **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_GridMap_cell_center_x:
- :ref:`bool<class_bool>` **cell_center_x** - If ``true`` grid items are centered on the X axis.
.. _class_GridMap_cell_center_y:
- :ref:`bool<class_bool>` **cell_center_y** - If ``true`` grid items are centered on the Y axis.
.. _class_GridMap_cell_center_z:
- :ref:`bool<class_bool>` **cell_center_z** - If ``true`` grid items are centered on the Z axis.
.. _class_GridMap_cell_octant_size:
- :ref:`int<class_int>` **cell_octant_size** - The size of each octant measured in number of cells. This applies to all three axis.
.. _class_GridMap_cell_scale:
- :ref:`float<class_float>` **cell_scale**
.. _class_GridMap_cell_size:
- :ref:`Vector3<class_vector3>` **cell_size** - The dimensions of the grid's cells.
.. _class_GridMap_collision_layer:
- :ref:`int<class_int>` **collision_layer**
@@ -92,6 +92,10 @@ Member Variables
- :ref:`int<class_int>` **collision_mask**
.. _class_GridMap_theme:
- :ref:`MeshLibrary<class_meshlibrary>` **theme** - The assigned :ref:`MeshLibrary<class_meshlibrary>`.
Numeric Constants
-----------------
@@ -142,30 +146,6 @@ The :ref:`MeshLibrary<class_meshlibrary>` item index located at the grid-based X
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retuned if the cell is empty.
.. _class_GridMap_get_cell_size:
- :ref:`Vector3<class_vector3>` **get_cell_size** **(** **)** const
The dimensions of the grid's cells.
.. _class_GridMap_get_center_x:
- :ref:`bool<class_bool>` **get_center_x** **(** **)** const
Returns whether or not grid items are centered on the X axis.
.. _class_GridMap_get_center_y:
- :ref:`bool<class_bool>` **get_center_y** **(** **)** const
Returns whether or not grid items are centered on the Y axis.
.. _class_GridMap_get_center_z:
- :ref:`bool<class_bool>` **get_center_z** **(** **)** const
Returns whether or not grid items are centered on the Z axis.
.. _class_GridMap_get_collision_layer_bit:
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
@@ -180,18 +160,6 @@ Returns whether or not grid items are centered on the Z axis.
Array of :ref:`Transform<class_transform>` and :ref:`Mesh<class_mesh>` references corresponding to the non empty cells in the grid. The transforms are specified in world space.
.. _class_GridMap_get_octant_size:
- :ref:`int<class_int>` **get_octant_size** **(** **)** const
The size of each octant measured in number of cells. This applies to all three axis.
.. _class_GridMap_get_theme:
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
The assigned :ref:`MeshLibrary<class_meshlibrary>`.
.. _class_GridMap_get_used_cells:
- :ref:`Array<class_array>` **get_used_cells** **(** **)** const
@@ -220,30 +188,6 @@ A negative item index will clear the cell.
Optionally, the item's orientation can be passed.
.. _class_GridMap_set_cell_size:
- void **set_cell_size** **(** :ref:`Vector3<class_vector3>` size **)**
Sets the height, width and depth of the grid's cells.
.. _class_GridMap_set_center_x:
- void **set_center_x** **(** :ref:`bool<class_bool>` enable **)**
Set grid items to be centered on the X axis. By default it is enabled.
.. _class_GridMap_set_center_y:
- void **set_center_y** **(** :ref:`bool<class_bool>` enable **)**
Set grid items to be centered on the Y axis. By default it is enabled.
.. _class_GridMap_set_center_z:
- void **set_center_z** **(** :ref:`bool<class_bool>` enable **)**
Set grid items to be centered on the Z axis. By default it is enabled.
.. _class_GridMap_set_clip:
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)**
@@ -256,18 +200,6 @@ Set grid items to be centered on the Z axis. By default it is enabled.
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
.. _class_GridMap_set_octant_size:
- void **set_octant_size** **(** :ref:`int<class_int>` size **)**
Sets the size for each octant measured in number of cells. This applies to all three axis.
.. _class_GridMap_set_theme:
- void **set_theme** **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)**
Sets the collection of meshes for the map.
.. _class_GridMap_world_to_map:
- :ref:`Vector3<class_vector3>` **world_to_map** **(** :ref:`Vector3<class_vector3>` pos **)** const
classes/class_httpclient.rst
+12 -32
View File
@@ -24,8 +24,6 @@ Member Functions
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_to_host<class_HTTPClient_connect_to_host>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port=-1, :ref:`bool<class_bool>` use_ssl=false, :ref:`bool<class_bool>` verify_host=true **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StreamPeer<class_streampeer>` | :ref:`get_connection<class_HTTPClient_get_connection>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_response_body_length<class_HTTPClient_get_response_body_length>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_response_code<class_HTTPClient_get_response_code>` **(** **)** const |
@@ -38,8 +36,6 @@ Member Functions
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_response<class_HTTPClient_has_response>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_blocking_mode_enabled<class_HTTPClient_is_blocking_mode_enabled>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`poll<class_HTTPClient_poll>` **(** **)** |
@@ -52,13 +48,21 @@ Member Functions
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request_raw<class_HTTPClient_request_raw>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blocking_mode<class_HTTPClient_set_blocking_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_connection<class_HTTPClient_set_connection>` **(** :ref:`StreamPeer<class_streampeer>` connection **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_read_chunk_size<class_HTTPClient_set_read_chunk_size>` **(** :ref:`int<class_int>` bytes **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_HTTPClient_blocking_mode_enabled:
- :ref:`bool<class_bool>` **blocking_mode_enabled** - If ``true``, execution will block until all data is read from the response.
.. _class_HTTPClient_connection:
- :ref:`StreamPeer<class_streampeer>` **connection** - The connection to use for this client.
Enums
-----
@@ -191,12 +195,6 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f
``verify_host`` will check the SSL identity of the host if set to ``true``.
.. _class_HTTPClient_get_connection:
- :ref:`StreamPeer<class_streampeer>` **get_connection** **(** **)** const
Returns the current connection.
.. _class_HTTPClient_get_response_body_length:
- :ref:`int<class_int>` **get_response_body_length** **(** **)** const
@@ -237,12 +235,6 @@ Returns a STATUS\_\* enum constant. Need to call :ref:`poll<class_HTTPClient_pol
If ``true`` this ``HTTPClient`` has a response available.
.. _class_HTTPClient_is_blocking_mode_enabled:
- :ref:`bool<class_bool>` **is_blocking_mode_enabled** **(** **)** const
If ``true`` blocking mode is enabled.
.. _class_HTTPClient_is_response_chunked:
- :ref:`bool<class_bool>` **is_response_chunked** **(** **)** const
@@ -300,18 +292,6 @@ Headers are HTTP request headers. For available HTTP methods, see ``METHOD\_\*``
Sends the body data raw, as a byte array and does not encode it in any way.
.. _class_HTTPClient_set_blocking_mode:
- void **set_blocking_mode** **(** :ref:`bool<class_bool>` enabled **)**
If set to true, execution will block until all data is read from the response.
.. _class_HTTPClient_set_connection:
- void **set_connection** **(** :ref:`StreamPeer<class_streampeer>` connection **)**
Sets connection to use for this client.
.. _class_HTTPClient_set_read_chunk_size:
- void **set_read_chunk_size** **(** :ref:`int<class_int>` bytes **)**
classes/class_httprequest.rst
+15 -27
View File
@@ -19,21 +19,17 @@ A node with the ability to send HTTP requests.
Member Functions
----------------
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_download_file<class_HTTPRequest_get_download_file>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_download_file<class_HTTPRequest_set_download_file>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)** |
+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -52,6 +48,10 @@ Member Variables
- :ref:`int<class_int>` **body_size_limit** - Maximum allowed size for response bodies.
.. _class_HTTPRequest_download_file:
- :ref:`String<class_string>` **download_file** - The file to download into. Will output any received file into it.
.. _class_HTTPRequest_max_redirects:
- :ref:`int<class_int>` **max_redirects** - Maximum number of allowed redirects.
@@ -104,12 +104,6 @@ Cancels the current request.
Returns the response body length.
.. _class_HTTPRequest_get_download_file:
- :ref:`String<class_string>` **get_download_file** **(** **)** const
Returns the file this request will download into.
.. _class_HTTPRequest_get_downloaded_bytes:
- :ref:`int<class_int>` **get_downloaded_bytes** **(** **)** const
@@ -126,10 +120,4 @@ Returns the current status of the underlying :ref:`HTTPClient<class_httpclient>`
- :ref:`int<class_int>` **request** **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)**
.. _class_HTTPRequest_set_download_file:
- void **set_download_file** **(** :ref:`String<class_string>` path **)**
Sets the file to download into. Outputs the response body into the file if set.
classes/class_imagetexture.rst
+25 -45
View File
@@ -19,27 +19,31 @@ A :ref:`Texture<class_texture>` based on an :ref:`Image<class_image>`.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create<class_ImageTexture_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_ImageTexture_get_lossy_storage_quality>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_storage<class_ImageTexture_get_storage>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_ImageTexture_set_data>` **(** :ref:`Image<class_image>` image **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_lossy_storage_quality<class_ImageTexture_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_ImageTexture_set_size_override>` **(** :ref:`Vector2<class_vector2>` size **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_storage<class_ImageTexture_set_storage>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create<class_ImageTexture_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_ImageTexture_set_data>` **(** :ref:`Image<class_image>` image **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_ImageTexture_set_size_override>` **(** :ref:`Vector2<class_vector2>` size **)** |
+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_ImageTexture_lossy_quality:
- :ref:`float<class_float>` **lossy_quality** - The storage quality for ``ImageTexture``.STORAGE_COMPRESS_LOSSY.
.. _class_ImageTexture_storage:
- :ref:`Storage<enum_imagetexture_storage>` **storage** - The storage type (raw, lossy, or compressed).
Enums
-----
@@ -83,18 +87,6 @@ Create a new ``ImageTexture`` from an :ref:`Image<class_image>` with "flags" fro
Return the format of the ``ImageTexture``, one of :ref:`Image<class_image>`.FORMAT\_\*.
.. _class_ImageTexture_get_lossy_storage_quality:
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
Return the storage quality for ``ImageTexture``.STORAGE_COMPRESS_LOSSY.
.. _class_ImageTexture_get_storage:
- :ref:`int<class_int>` **get_storage** **(** **)** const
Return the storage type. One of ``ImageTexture``.STORAGE\_\*.
.. _class_ImageTexture_load:
- void **load** **(** :ref:`String<class_string>` path **)**
@@ -107,22 +99,10 @@ Load an ``ImageTexture``.
Set the :ref:`Image<class_image>` of this ``ImageTexture``.
.. _class_ImageTexture_set_lossy_storage_quality:
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
Set the storage quality in case of ``ImageTexture``.STORAGE_COMPRESS_LOSSY.
.. _class_ImageTexture_set_size_override:
- void **set_size_override** **(** :ref:`Vector2<class_vector2>` size **)**
Resizes the ``ImageTexture`` to the specified dimensions.
.. _class_ImageTexture_set_storage:
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
Set the storage type. One of ``ImageTexture``.STORAGE\_\*.
classes/class_itemlist.rst
+4 -12
View File
@@ -28,8 +28,6 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`ensure_current_is_visible<class_ItemList_ensure_current_is_visible>` **(** **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_fixed_icon_size<class_ItemList_get_fixed_icon_size>` **(** **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_at_position<class_ItemList_get_item_at_position>` **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` exact=false **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_count<class_ItemList_get_item_count>` **(** **)** const |
@@ -62,8 +60,6 @@ Member Functions
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`select<class_ItemList_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fixed_icon_size<class_ItemList_set_fixed_icon_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_custom_bg_color<class_ItemList_set_item_custom_bg_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` custom_bg_color **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_disabled<class_ItemList_set_item_disabled>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)** |
@@ -142,6 +138,10 @@ Member Variables
- :ref:`int<class_int>` **fixed_column_width**
.. _class_ItemList_fixed_icon_size:
- :ref:`Vector2<class_vector2>` **fixed_icon_size**
.. _class_ItemList_icon_mode:
- :ref:`IconMode<enum_itemlist_iconmode>` **icon_mode**
@@ -225,10 +225,6 @@ Remove all items from the list.
Ensure selection is visible, adjusting the scroll position as necessary.
.. _class_ItemList_get_fixed_icon_size:
- :ref:`Vector2<class_vector2>` **get_fixed_icon_size** **(** **)** const
.. _class_ItemList_get_item_at_position:
- :ref:`int<class_int>` **get_item_at_position** **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` exact=false **)** const
@@ -319,10 +315,6 @@ Select the item at the specified index.
Note: This method does not trigger the item selection signal.
.. _class_ItemList_set_fixed_icon_size:
- void **set_fixed_icon_size** **(** :ref:`Vector2<class_vector2>` size **)**
.. _class_ItemList_set_item_custom_bg_color:
- void **set_item_custom_bg_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` custom_bg_color **)**
classes/class_label.rst
+13 -25
View File
@@ -19,19 +19,15 @@ Displays plain text in a line or wrapped inside a rectangle. For formatted text,
Member Functions
----------------
+------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_count<class_Label_get_line_count>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_height<class_Label_get_line_height>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_total_character_count<class_Label_get_total_character_count>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_characters<class_Label_get_visible_characters>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_line_count<class_Label_get_visible_line_count>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_characters<class_Label_set_visible_characters>` **(** :ref:`int<class_int>` amount **)** |
+------------------------+------------------------------------------------------------------------------------------------------------+
+------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_count<class_Label_get_line_count>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_height<class_Label_get_line_height>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_total_character_count<class_Label_get_total_character_count>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_line_count<class_Label_get_visible_line_count>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -72,6 +68,10 @@ Member Variables
- :ref:`VAlign<enum_label_valign>` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN\_\*`` constants.
.. _class_Label_visible_characters:
- :ref:`int<class_int>` **visible_characters** - Restricts the number of characters to display. Set to -1 to disable.
Enums
-----
@@ -123,22 +123,10 @@ Returns the font size in pixels.
Returns the total length of the text.
.. _class_Label_get_visible_characters:
- :ref:`int<class_int>` **get_visible_characters** **(** **)** const
Returns the restricted number of characters to display. Returns -1 if unrestricted.
.. _class_Label_get_visible_line_count:
- :ref:`int<class_int>` **get_visible_line_count** **(** **)** const
Returns the number of lines shown. Useful if the ``Label`` 's height cannot currently display all lines.
.. _class_Label_set_visible_characters:
- void **set_visible_characters** **(** :ref:`int<class_int>` amount **)**
Restricts the number of characters to display. Set to -1 to disable.
classes/class_lineedit.rst
+4 -16
View File
@@ -26,8 +26,6 @@ Member Functions
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`deselect<class_LineEdit_deselect>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cursor_position<class_LineEdit_get_cursor_position>` **(** **)** const |
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_popupmenu>` | :ref:`get_menu<class_LineEdit_get_menu>` **(** **)** const |
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`menu_option<class_LineEdit_menu_option>` **(** :ref:`int<class_int>` option **)** |
@@ -36,8 +34,6 @@ Member Functions
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`select_all<class_LineEdit_select_all>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cursor_position<class_LineEdit_set_cursor_position>` **(** :ref:`int<class_int>` position **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -70,6 +66,10 @@ Member Variables
- :ref:`float<class_float>` **caret_blink_speed** - Duration (in seconds) of a caret's blinking cycle.
.. _class_LineEdit_caret_position:
- :ref:`int<class_int>` **caret_position** - The cursor's position inside the ``LineEdit``. When set, the text may scroll to accomodate it.
.. _class_LineEdit_context_menu_enabled:
- :ref:`bool<class_bool>` **context_menu_enabled** - If ``true`` the context menu will appear when right clicked.
@@ -159,12 +159,6 @@ Erases the :ref:`LineEdit<class_lineedit>` text.
Clears the current selection.
.. _class_LineEdit_get_cursor_position:
- :ref:`int<class_int>` **get_cursor_position** **(** **)** const
Returns the cursor position inside the ``LineEdit``.
.. _class_LineEdit_get_menu:
- :ref:`PopupMenu<class_popupmenu>` **get_menu** **(** **)** const
@@ -196,10 +190,4 @@ Selects characters inside :ref:`LineEdit<class_lineedit>` between ``from`` and `
Selects the whole :ref:`String<class_string>`.
.. _class_LineEdit_set_cursor_position:
- void **set_cursor_position** **(** :ref:`int<class_int>` position **)**
Sets the cursor position inside the ``LineEdit``. The text may scroll if needed.
classes/class_networkedmultiplayerenet.rst
+8 -12
View File
@@ -26,12 +26,16 @@ Member Functions
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_server<class_NetworkedMultiplayerENet_create_server>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` max_clients=32, :ref:`int<class_int>` in_bandwidth=0, :ref:`int<class_int>` out_bandwidth=0 **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_compression_mode<class_NetworkedMultiplayerENet_get_compression_mode>` **(** **)** const |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_ip<class_NetworkedMultiplayerENet_set_bind_ip>` **(** :ref:`String<class_string>` ip **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_compression_mode<class_NetworkedMultiplayerENet_set_compression_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_NetworkedMultiplayerENet_compression_mode:
- :ref:`CompressionMode<enum_networkedmultiplayerenet_compressionmode>` **compression_mode**
Enums
-----
@@ -71,16 +75,8 @@ Create client that connects to a server at address ``ip`` using specified ``port
Create server that listens to connections via ``port``.
.. _class_NetworkedMultiplayerENet_get_compression_mode:
- :ref:`int<class_int>` **get_compression_mode** **(** **)** const
.. _class_NetworkedMultiplayerENet_set_bind_ip:
- void **set_bind_ip** **(** :ref:`String<class_string>` ip **)**
.. _class_NetworkedMultiplayerENet_set_compression_mode:
- void **set_compression_mode** **(** :ref:`int<class_int>` mode **)**
classes/class_networkedmultiplayerpeer.rst
+23 -35
View File
@@ -21,23 +21,17 @@ A high-level network interface to simplify multiplayer interactions.
Member Functions
----------------
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_status<class_NetworkedMultiplayerPeer_get_connection_status>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_peer<class_NetworkedMultiplayerPeer_get_packet_peer>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unique_id<class_NetworkedMultiplayerPeer_get_unique_id>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_refusing_new_connections<class_NetworkedMultiplayerPeer_is_refusing_new_connections>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_NetworkedMultiplayerPeer_poll>` **(** **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_refuse_new_connections<class_NetworkedMultiplayerPeer_set_refuse_new_connections>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>` **(** :ref:`int<class_int>` id **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transfer_mode<class_NetworkedMultiplayerPeer_set_transfer_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_status<class_NetworkedMultiplayerPeer_get_connection_status>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_peer<class_NetworkedMultiplayerPeer_get_packet_peer>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unique_id<class_NetworkedMultiplayerPeer_get_unique_id>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_NetworkedMultiplayerPeer_poll>` **(** **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_target_peer<class_NetworkedMultiplayerPeer_set_target_peer>` **(** :ref:`int<class_int>` id **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -73,6 +67,18 @@ Emitted by the server when a client disconnects.
Emitted by clients when the server disconnects.
Member Variables
----------------
.. _class_NetworkedMultiplayerPeer_refuse_new_connections:
- :ref:`bool<class_bool>` **refuse_new_connections** - If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``.
.. _class_NetworkedMultiplayerPeer_transfer_mode:
- :ref:`TransferMode<enum_networkedmultiplayerpeer_transfermode>` **transfer_mode** - The manner in which to send packets to the ``target_peer``. See enum TransferMode.
Numeric Constants
-----------------
@@ -125,34 +131,16 @@ Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent pack
Returns the ID of this ``NetworkedMultiplayerPeer``.
.. _class_NetworkedMultiplayerPeer_is_refusing_new_connections:
- :ref:`bool<class_bool>` **is_refusing_new_connections** **(** **)** const
Returns ``true`` if this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``.
.. _class_NetworkedMultiplayerPeer_poll:
- void **poll** **(** **)**
Waits up to 1 second to receive a new network event.
.. _class_NetworkedMultiplayerPeer_set_refuse_new_connections:
- void **set_refuse_new_connections** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``.
.. _class_NetworkedMultiplayerPeer_set_target_peer:
- void **set_target_peer** **(** :ref:`int<class_int>` id **)**
The peer to which packets will be sent. Default value: ``0``.
.. _class_NetworkedMultiplayerPeer_set_transfer_mode:
- void **set_transfer_mode** **(** :ref:`int<class_int>` mode **)**
The manner in which to send packets to the ``target_peer``. See enum TransferMode.
classes/class_node.rst
+14 -48
View File
@@ -56,22 +56,16 @@ Member Functions
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_children<class_Node_get_children>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_filename<class_Node_get_filename>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_groups<class_Node_get_groups>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index<class_Node_get_index>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_Node_get_name>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_network_master<class_Node_get_network_master>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_node<class_Node_get_node>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_node_and_resource<class_Node_get_node_and_resource>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_owner<class_Node_get_owner>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_parent<class_Node_get_parent>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_path<class_Node_get_path>` **(** **)** const |
@@ -166,14 +160,8 @@ Member Functions
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_display_folded<class_Node_set_display_folded>` **(** :ref:`bool<class_bool>` fold **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_filename<class_Node_set_filename>` **(** :ref:`String<class_string>` filename **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_name<class_Node_set_name>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_network_master<class_Node_set_network_master>` **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` recursive=true **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_owner<class_Node_set_owner>` **(** :ref:`Node<class_node>` owner **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_physics_process<class_Node_set_physics_process>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_physics_process_internal<class_Node_set_physics_process_internal>` **(** :ref:`bool<class_bool>` enable **)** |
@@ -216,6 +204,20 @@ Emitted when the node exits the tree.
Member Variables
----------------
.. _class_Node_filename:
- :ref:`String<class_string>` **filename** - When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.
.. _class_Node_name:
- :ref:`String<class_string>` **name** - The name of the node. This name is unique among the siblings (other child nodes from the same parent).
When set to an existing name, the node will be automatically renamed
.. _class_Node_owner:
- :ref:`Node<class_node>` **owner** - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree<class_scenetree>`\ s, with instancing and subinstancing.
.. _class_Node_pause_mode:
- :ref:`PauseMode<enum_node_pausemode>` **pause_mode**
@@ -423,12 +425,6 @@ Returns the number of child nodes.
Returns an array of references to node's children.
.. _class_Node_get_filename:
- :ref:`String<class_string>` **get_filename** **(** **)** const
Returns a filename that may be contained by the node. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded (see :ref:`set_filename<class_Node_set_filename>`).
.. _class_Node_get_groups:
- :ref:`Array<class_array>` **get_groups** **(** **)** const
@@ -441,12 +437,6 @@ Returns an array listing the groups that the node is a member of.
Returns the node's index, i.e. its position among the siblings of its parent.
.. _class_Node_get_name:
- :ref:`String<class_string>` **get_name** **(** **)** const
Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent).
.. _class_Node_get_network_master:
- :ref:`int<class_int>` **get_network_master** **(** **)** const
@@ -487,12 +477,6 @@ Possible paths are:
- :ref:`Array<class_array>` **get_node_and_resource** **(** :ref:`NodePath<class_nodepath>` path **)**
.. _class_Node_get_owner:
- :ref:`Node<class_node>` **get_owner** **(** **)** const
Returns the node owner (see :ref:`set_owner<class_Node_set_owner>`).
.. _class_Node_get_parent:
- :ref:`Node<class_node>` **get_parent** **(** **)** const
@@ -763,30 +747,12 @@ Remotely changes property's value on a specific peer identified by *peer_id* usi
Sets the folded state of the node in the Scene dock.
.. _class_Node_set_filename:
- void **set_filename** **(** :ref:`String<class_string>` filename **)**
A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.
.. _class_Node_set_name:
- void **set_name** **(** :ref:`String<class_string>` name **)**
Sets the name of the node. The name must be unique within the parent. Using an existing name will cause the node to be automatically renamed.
.. _class_Node_set_network_master:
- void **set_network_master** **(** :ref:`int<class_int>` id, :ref:`bool<class_bool>` recursive=true **)**
Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server).
.. _class_Node_set_owner:
- void **set_owner** **(** :ref:`Node<class_node>` owner **)**
Sets the node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree<class_scenetree>`\ s, with instancing and subinstancing.
.. _class_Node_set_physics_process:
- void **set_physics_process** **(** :ref:`bool<class_bool>` enable **)**
classes/class_node2d.rst
+4 -12
View File
@@ -28,8 +28,6 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_relative_transform_to_parent<class_Node2D_get_relative_transform_to_parent>` **(** :ref:`Node<class_node>` parent **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_Node2D_get_rotation>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_translate<class_Node2D_global_translate>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`look_at<class_Node2D_look_at>` **(** :ref:`Vector2<class_vector2>` point **)** |
@@ -40,8 +38,6 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate<class_Node2D_rotate>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_Node2D_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`to_global<class_Node2D_to_global>` **(** :ref:`Vector2<class_vector2>` local_point **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`to_local<class_Node2D_to_local>` **(** :ref:`Vector2<class_vector2>` global_point **)** const |
@@ -76,6 +72,10 @@ Member Variables
- :ref:`Vector2<class_vector2>` **position** - Position, relative to the node's parent.
.. _class_Node2D_rotation:
- :ref:`float<class_float>` **rotation** - Rotation in radians, relative to the node's parent.
.. _class_Node2D_rotation_degrees:
- :ref:`float<class_float>` **rotation_degrees** - Rotation in degrees, relative to the node's parent.
@@ -123,10 +123,6 @@ Returns the angle between the node and the 'point' in radians.
Returns the :ref:`Transform2D<class_transform2d>` relative to this node's parent.
.. _class_Node2D_get_rotation:
- :ref:`float<class_float>` **get_rotation** **(** **)** const
.. _class_Node2D_global_translate:
- void **global_translate** **(** :ref:`Vector2<class_vector2>` offset **)**
@@ -157,10 +153,6 @@ Applies a local translation on the node's Y axis based on the :ref:`Node._proces
Applies a rotation to the node, in radians, starting from its current rotation.
.. _class_Node2D_set_rotation:
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
.. _class_Node2D_to_global:
- :ref:`Vector2<class_vector2>` **to_global** **(** :ref:`Vector2<class_vector2>` local_point **)** const
classes/class_os.rst
+60 -222
View File
@@ -38,14 +38,8 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_find_scancode_from_string>` **(** :ref:`String<class_string>` string **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_borderless_window<class_OS_get_borderless_window>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_clipboard<class_OS_get_clipboard>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_cmdline_args<class_OS_get_cmdline_args>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_current_screen<class_OS_get_current_screen>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_date<class_OS_get_date>` **(** :ref:`bool<class_bool>` utc=false **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_datetime<class_OS_get_datetime>` **(** :ref:`bool<class_bool>` utc=false **)** const |
@@ -58,8 +52,6 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_executable_path<class_OS_get_executable_path>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_exit_code<class_OS_get_exit_code>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_latin_keyboard_variant<class_OS_get_latin_keyboard_variant>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_locale<class_OS_get_locale>` **(** **)** const |
@@ -84,8 +76,6 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_screen_dpi<class_OS_get_screen_dpi>` **(** :ref:`int<class_int>` screen=-1 **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_screen_orientation<class_OS_get_screen_orientation>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_screen_position<class_OS_get_screen_position>` **(** :ref:`int<class_int>` screen=-1 **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_screen_size<class_OS_get_screen_size>` **(** :ref:`int<class_int>` screen=-1 **)** const |
@@ -116,10 +106,6 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_virtual_keyboard_height<class_OS_get_virtual_keyboard_height>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_window_position<class_OS_get_window_position>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_window_size<class_OS_get_window_size>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_environment<class_OS_has_environment>` **(** :ref:`String<class_string>` environment **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_feature<class_OS_has_feature>` **(** :ref:`String<class_string>` tag_name **)** const |
@@ -132,10 +118,6 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debug_build<class_OS_is_debug_build>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_in_low_processor_usage_mode<class_OS_is_in_low_processor_usage_mode>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_keep_screen_on<class_OS_is_keep_screen_on>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ok_left_and_cancel_right<class_OS_is_ok_left_and_cancel_right>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scancode_unicode<class_OS_is_scancode_unicode>` **(** :ref:`int<class_int>` code **)** const |
@@ -144,16 +126,6 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_userfs_persistent<class_OS_is_userfs_persistent>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_vsync_enabled<class_OS_is_vsync_enabled>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_fullscreen<class_OS_is_window_fullscreen>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_maximized<class_OS_is_window_maximized>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_minimized<class_OS_is_window_minimized>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_window_resizable<class_OS_is_window_resizable>` **(** **)** const |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`kill<class_OS_kill>` **(** :ref:`int<class_int>` pid **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`native_video_is_playing<class_OS_native_video_is_playing>` **(** **)** |
@@ -176,42 +148,14 @@ Member Functions
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`request_attention<class_OS_request_attention>` **(** **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_borderless_window<class_OS_set_borderless_window>` **(** :ref:`bool<class_bool>` borderless **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clipboard<class_OS_set_clipboard>` **(** :ref:`String<class_string>` clipboard **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_screen<class_OS_set_current_screen>` **(** :ref:`int<class_int>` screen **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exit_code<class_OS_set_exit_code>` **(** :ref:`int<class_int>` code **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_OS_set_icon>` **(** :ref:`Image<class_image>` icon **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ime_position<class_OS_set_ime_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_screen_on<class_OS_set_keep_screen_on>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_low_processor_usage_mode<class_OS_set_low_processor_usage_mode>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_screen_orientation<class_OS_set_screen_orientation>` **(** :ref:`int<class_int>` orientation **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`set_thread_name<class_OS_set_thread_name>` **(** :ref:`String<class_string>` name **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_file_access_save_and_swap<class_OS_set_use_file_access_save_and_swap>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_vsync<class_OS_set_use_vsync>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_fullscreen<class_OS_set_window_fullscreen>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_maximized<class_OS_set_window_maximized>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_minimized<class_OS_set_window_minimized>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_position<class_OS_set_window_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_resizable<class_OS_set_window_resizable>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_size<class_OS_set_window_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_window_title<class_OS_set_window_title>` **(** :ref:`String<class_string>` title **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shell_open<class_OS_shell_open>` **(** :ref:`String<class_string>` uri **)** |
@@ -219,6 +163,66 @@ Member Functions
| void | :ref:`show_virtual_keyboard<class_OS_show_virtual_keyboard>` **(** :ref:`String<class_string>` existing_text="" **)** |
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_OS_clipboard:
- :ref:`String<class_string>` **clipboard** - The clipboard from the host OS. Might be unavailable on some platforms.
.. _class_OS_current_screen:
- :ref:`int<class_int>` **current_screen** - The current screen index (starting from 0).
.. _class_OS_exit_code:
- :ref:`int<class_int>` **exit_code**
.. _class_OS_keep_screen_on:
- :ref:`bool<class_bool>` **keep_screen_on**
.. _class_OS_low_processor_usage_mode:
- :ref:`bool<class_bool>` **low_processor_usage_mode**
.. _class_OS_screen_orientation:
- _OS.ScreenOrientation **screen_orientation** - The current screen orientation.
.. _class_OS_vsync_enabled:
- :ref:`bool<class_bool>` **vsync_enabled**
.. _class_OS_window_borderless:
- :ref:`bool<class_bool>` **window_borderless** - If ``true``, removes the window frame.
.. _class_OS_window_fullscreen:
- :ref:`bool<class_bool>` **window_fullscreen** - If ``true``, the window is fullscreen.
.. _class_OS_window_maximized:
- :ref:`bool<class_bool>` **window_maximized** - If ``true``, the window is maximized.
.. _class_OS_window_minimized:
- :ref:`bool<class_bool>` **window_minimized** - If ``true``, the window is minimized.
.. _class_OS_window_position:
- :ref:`Vector2<class_vector2>` **window_position** - The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
.. _class_OS_window_resizable:
- :ref:`bool<class_bool>` **window_resizable** - If ``true``, the window is resizable by the user.
.. _class_OS_window_size:
- :ref:`Vector2<class_vector2>` **window_size** - The size of the window (without counting window manager decorations).
Enums
-----
@@ -355,30 +359,12 @@ Execute the binary file in given path, optionally blocking until it returns. A p
Returns the scancode of the given string (e.g. "Escape")
.. _class_OS_get_borderless_window:
- :ref:`bool<class_bool>` **get_borderless_window** **(** **)** const
Returns true if the current window is borderless.
.. _class_OS_get_clipboard:
- :ref:`String<class_string>` **get_clipboard** **(** **)** const
Get clipboard from the host OS.
.. _class_OS_get_cmdline_args:
- :ref:`PoolStringArray<class_poolstringarray>` **get_cmdline_args** **(** **)**
Returns the command line arguments passed to the engine.
.. _class_OS_get_current_screen:
- :ref:`int<class_int>` **get_current_screen** **(** **)** const
Returns the current screen index (0 padded).
.. _class_OS_get_date:
- :ref:`Dictionary<class_dictionary>` **get_date** **(** :ref:`bool<class_bool>` utc=false **)** const
@@ -417,10 +403,6 @@ Returns an environment variable.
Returns the path to the current engine executable.
.. _class_OS_get_exit_code:
- :ref:`int<class_int>` **get_exit_code** **(** **)** const
.. _class_OS_get_latin_keyboard_variant:
- :ref:`String<class_string>` **get_latin_keyboard_variant** **(** **)** const
@@ -511,12 +493,6 @@ xxhdpi - 480 dpi
xxxhdpi - 640 dpi
.. _class_OS_get_screen_orientation:
- :ref:`int<class_int>` **get_screen_orientation** **(** **)** const
Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class.
.. _class_OS_get_screen_position:
- :ref:`Vector2<class_vector2>` **get_screen_position** **(** :ref:`int<class_int>` screen=-1 **)** const
@@ -607,18 +583,6 @@ Returns the absolute directory path where user data is written (``user://``).
- :ref:`int<class_int>` **get_virtual_keyboard_height** **(** **)**
.. _class_OS_get_window_position:
- :ref:`Vector2<class_vector2>` **get_window_position** **(** **)** const
Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right.
.. _class_OS_get_window_size:
- :ref:`Vector2<class_vector2>` **get_window_size** **(** **)** const
Returns the size of the window (without counting window manager decorations).
.. _class_OS_has_environment:
- :ref:`bool<class_bool>` **has_environment** **(** :ref:`String<class_string>` environment **)** const
@@ -657,18 +621,6 @@ Returns ``true`` when running in the editor.
Returns ``false`` if the build is a release build.
.. _class_OS_is_in_low_processor_usage_mode:
- :ref:`bool<class_bool>` **is_in_low_processor_usage_mode** **(** **)** const
Returns ``true`` if low cpu usage mode is enabled.
.. _class_OS_is_keep_screen_on:
- :ref:`bool<class_bool>` **is_keep_screen_on** **(** **)** const
Returns ``true`` if the screen is being kept on.
.. _class_OS_is_ok_left_and_cancel_right:
- :ref:`bool<class_bool>` **is_ok_left_and_cancel_right** **(** **)** const
@@ -693,36 +645,6 @@ Returns ``true`` if the engine was executed with -v (verbose stdout).
If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable.
.. _class_OS_is_vsync_enabled:
- :ref:`bool<class_bool>` **is_vsync_enabled** **(** **)** const
Returns ``true`` if synchronizing the framerate to the monitor's refresh rate is enabled.
.. _class_OS_is_window_fullscreen:
- :ref:`bool<class_bool>` **is_window_fullscreen** **(** **)** const
Returns ``true`` if the window is in fullscreen mode.
.. _class_OS_is_window_maximized:
- :ref:`bool<class_bool>` **is_window_maximized** **(** **)** const
Returns ``true`` if the window is maximized.
.. _class_OS_is_window_minimized:
- :ref:`bool<class_bool>` **is_window_minimized** **(** **)** const
Returns ``true`` if the window is minimized.
.. _class_OS_is_window_resizable:
- :ref:`bool<class_bool>` **is_window_resizable** **(** **)** const
Returns ``true`` if the window is resizable.
.. _class_OS_kill:
- :ref:`int<class_int>` **kill** **(** :ref:`int<class_int>` pid **)**
@@ -789,30 +711,6 @@ Shows all resources currently used by the game.
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
.. _class_OS_set_borderless_window:
- void **set_borderless_window** **(** :ref:`bool<class_bool>` borderless **)**
Removes the window frame.
.. _class_OS_set_clipboard:
- void **set_clipboard** **(** :ref:`String<class_string>` clipboard **)**
Sets clipboard to the OS.
.. _class_OS_set_current_screen:
- void **set_current_screen** **(** :ref:`int<class_int>` screen **)**
Sets the current screen by index.
.. _class_OS_set_exit_code:
- void **set_exit_code** **(** :ref:`int<class_int>` code **)**
Sets the exit code that will be returned by the game.
.. _class_OS_set_icon:
- void **set_icon** **(** :ref:`Image<class_image>` icon **)**
@@ -823,24 +721,6 @@ Sets the game's icon.
- void **set_ime_position** **(** :ref:`Vector2<class_vector2>` position **)**
.. _class_OS_set_keep_screen_on:
- void **set_keep_screen_on** **(** :ref:`bool<class_bool>` enabled **)**
Sets keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS)
.. _class_OS_set_low_processor_usage_mode:
- void **set_low_processor_usage_mode** **(** :ref:`bool<class_bool>` enable **)**
Set to ``true`` to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. Use this in tool mode to reduce CPU usage.
.. _class_OS_set_screen_orientation:
- void **set_screen_orientation** **(** :ref:`int<class_int>` orientation **)**
Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class.
.. _class_OS_set_thread_name:
- :ref:`int<class_int>` **set_thread_name** **(** :ref:`String<class_string>` name **)**
@@ -853,48 +733,6 @@ Sets the name of the current thread.
Enables backup saves if ``enabled`` is ``true``.
.. _class_OS_set_use_vsync:
- void **set_use_vsync** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` the framerate will synchronize to the monitor's refresh rate.
.. _class_OS_set_window_fullscreen:
- void **set_window_fullscreen** **(** :ref:`bool<class_bool>` enabled **)**
Sets window fullscreen mode to the *enabled* argument, *enabled* is a toggle for the fullscreen mode, calling the function with *enabled* true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with *enabled* false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode.
.. _class_OS_set_window_maximized:
- void **set_window_maximized** **(** :ref:`bool<class_bool>` enabled **)**
Set ``true`` to maximize the window.
.. _class_OS_set_window_minimized:
- void **set_window_minimized** **(** :ref:`bool<class_bool>` enabled **)**
Set ``true`` to minimize the window.
.. _class_OS_set_window_position:
- void **set_window_position** **(** :ref:`Vector2<class_vector2>` position **)**
Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen).
.. _class_OS_set_window_resizable:
- void **set_window_resizable** **(** :ref:`bool<class_bool>` enabled **)**
Sets the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings.
.. _class_OS_set_window_size:
- void **set_window_size** **(** :ref:`Vector2<class_vector2>` size **)**
Sets the window size to the specified size.
.. _class_OS_set_window_title:
- void **set_window_title** **(** :ref:`String<class_string>` title **)**
classes/class_packetpeer.rst
+21 -25
View File
@@ -21,23 +21,27 @@ Abstraction and base class for packet-based protocols.
Member Functions
----------------
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_packet_count<class_PacketPeer_get_available_packet_count>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_packet<class_PacketPeer_get_packet>` **(** **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_error<class_PacketPeer_get_packet_error>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_var<class_PacketPeer_get_var>` **(** **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_object_decoding_allowed<class_PacketPeer_is_object_decoding_allowed>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_packet<class_PacketPeer_put_packet>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_var<class_PacketPeer_put_var>` **(** :ref:`Variant<class_variant>` var **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_allow_object_decoding<class_PacketPeer_set_allow_object_decoding>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_packet_count<class_PacketPeer_get_available_packet_count>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_packet<class_PacketPeer_get_packet>` **(** **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_packet_error<class_PacketPeer_get_packet_error>` **(** **)** const |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_var<class_PacketPeer_get_var>` **(** **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_packet<class_PacketPeer_put_packet>` **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_var<class_PacketPeer_put_var>` **(** :ref:`Variant<class_variant>` var **)** |
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PacketPeer_allow_object_decoding:
- :ref:`bool<class_bool>` **allow_object_decoding**
Description
-----------
@@ -71,10 +75,6 @@ Return the error state of the last packet received (via :ref:`get_packet<class_P
Get a Variant.
.. _class_PacketPeer_is_object_decoding_allowed:
- :ref:`bool<class_bool>` **is_object_decoding_allowed** **(** **)** const
.. _class_PacketPeer_put_packet:
- :ref:`int<class_int>` **put_packet** **(** :ref:`PoolByteArray<class_poolbytearray>` buffer **)**
@@ -87,8 +87,4 @@ Send a raw packet.
Send a Variant as a packet.
.. _class_PacketPeer_set_allow_object_decoding:
- void **set_allow_object_decoding** **(** :ref:`bool<class_bool>` enable **)**
classes/class_packetpeerstream.rst
+13 -38
View File
@@ -16,49 +16,24 @@ Brief Description
Wrapper to use a PacketPeer over a StreamPeer.
Member Functions
Member Variables
----------------
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_input_buffer_max_size<class_PacketPeerStream_get_input_buffer_max_size>` **(** **)** const |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_output_buffer_max_size<class_PacketPeerStream_get_output_buffer_max_size>` **(** **)** const |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_buffer_max_size<class_PacketPeerStream_set_input_buffer_max_size>` **(** :ref:`int<class_int>` max_size_bytes **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_output_buffer_max_size<class_PacketPeerStream_set_output_buffer_max_size>` **(** :ref:`int<class_int>` max_size_bytes **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream_peer<class_PacketPeerStream_set_stream_peer>` **(** :ref:`Reference<class_reference>` peer **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
.. _class_PacketPeerStream_input_buffer_max_size:
- :ref:`int<class_int>` **input_buffer_max_size**
.. _class_PacketPeerStream_output_buffer_max_size:
- :ref:`int<class_int>` **output_buffer_max_size**
.. _class_PacketPeerStream_stream_peer:
- :ref:`StreamPeer<class_streampeer>` **stream_peer** - The wrapped :ref:`StreamPeer<class_streampeer>` object.
Description
-----------
PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly.
Member Function Description
---------------------------
.. _class_PacketPeerStream_get_input_buffer_max_size:
- :ref:`int<class_int>` **get_input_buffer_max_size** **(** **)** const
.. _class_PacketPeerStream_get_output_buffer_max_size:
- :ref:`int<class_int>` **get_output_buffer_max_size** **(** **)** const
.. _class_PacketPeerStream_set_input_buffer_max_size:
- void **set_input_buffer_max_size** **(** :ref:`int<class_int>` max_size_bytes **)**
.. _class_PacketPeerStream_set_output_buffer_max_size:
- void **set_output_buffer_max_size** **(** :ref:`int<class_int>` max_size_bytes **)**
.. _class_PacketPeerStream_set_stream_peer:
- void **set_stream_peer** **(** :ref:`Reference<class_reference>` peer **)**
Set the :ref:`StreamPeer<class_streampeer>` object to be wrapped.
classes/class_pathfollow.rst
+33 -124
View File
@@ -16,38 +16,41 @@ Brief Description
Point sampler for a :ref:`Path<class_path>`.
Member Functions
Member Variables
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_cubic_interpolation<class_PathFollow_get_cubic_interpolation>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_PathFollow_get_h_offset>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_PathFollow_get_offset>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rotation_mode<class_PathFollow_get_rotation_mode>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_unit_offset<class_PathFollow_get_unit_offset>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_PathFollow_get_v_offset>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_PathFollow_has_loop>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cubic_interpolation<class_PathFollow_set_cubic_interpolation>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_PathFollow_set_h_offset>` **(** :ref:`float<class_float>` h_offset **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_PathFollow_set_loop>` **(** :ref:`bool<class_bool>` loop **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_PathFollow_set_offset>` **(** :ref:`float<class_float>` offset **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation_mode<class_PathFollow_set_rotation_mode>` **(** :ref:`int<class_int>` rotation_mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_unit_offset<class_PathFollow_set_unit_offset>` **(** :ref:`float<class_float>` unit_offset **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_PathFollow_set_v_offset>` **(** :ref:`float<class_float>` v_offset **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
.. _class_PathFollow_cubic_interp:
- :ref:`bool<class_bool>` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the :ref:`Curve3D<class_curve3d>` of the :ref:`Path<class_path>` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
.. _class_PathFollow_h_offset:
- :ref:`float<class_float>` **h_offset** - The node's offset along the curve.
.. _class_PathFollow_loop:
- :ref:`bool<class_bool>` **loop** - If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
.. _class_PathFollow_offset:
- :ref:`float<class_float>` **offset** - The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
.. _class_PathFollow_rotation_mode:
- :ref:`RotationMode<enum_pathfollow_rotationmode>` **rotation_mode** - Allows or forbids rotation on one or more axes, depending on the constants being used.
.. _class_PathFollow_unit_offset:
- :ref:`float<class_float>` **unit_offset** - The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
.. _class_PathFollow_v_offset:
- :ref:`float<class_float>` **v_offset** - The node's offset perpendicular to the curve.
Enums
-----
@@ -69,97 +72,3 @@ This node takes its parent :ref:`Path<class_path>`, and returns the coordinates
It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
Member Function Description
---------------------------
.. _class_PathFollow_get_cubic_interpolation:
- :ref:`bool<class_bool>` **get_cubic_interpolation** **(** **)** const
This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation<class_PathFollow_set_cubic_interpolation>`) is interpolated linearly, or cubicly.
.. _class_PathFollow_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
Returns the X displacement this node has from its parent :ref:`Path<class_path>`.
.. _class_PathFollow_get_offset:
- :ref:`float<class_float>` **get_offset** **(** **)** const
Returns the distance along the path in 3D units.
.. _class_PathFollow_get_rotation_mode:
- :ref:`int<class_int>` **get_rotation_mode** **(** **)** const
Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode.
.. _class_PathFollow_get_unit_offset:
- :ref:`float<class_float>` **get_unit_offset** **(** **)** const
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
.. _class_PathFollow_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
Returns the Y displacement this node has from its parent :ref:`Path<class_path>`.
.. _class_PathFollow_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Returns whether this node wraps its offsets around, or truncates them to the path ends.
.. _class_PathFollow_set_cubic_interpolation:
- void **set_cubic_interpolation** **(** :ref:`bool<class_bool>` enable **)**
The points along the :ref:`Curve3D<class_curve3d>` of the :ref:`Path<class_path>` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
.. _class_PathFollow_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` h_offset **)**
Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
A similar effect may be achieved moving the this node's descendants.
.. _class_PathFollow_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` loop **)**
If set, any offset outside the path's length (whether set by :ref:`set_offset<class_PathFollow_set_offset>` or :ref:`set_unit_offset<class_PathFollow_set_unit_offset>` will wrap around, instead of stopping at the ends. Set it for cyclic paths.
.. _class_PathFollow_set_offset:
- void **set_offset** **(** :ref:`float<class_float>` offset **)**
Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path.
.. _class_PathFollow_set_rotation_mode:
- void **set_rotation_mode** **(** :ref:`int<class_int>` rotation_mode **)**
Allows or forbids rotation on one or more axes, per the constants below.
.. _class_PathFollow_set_unit_offset:
- void **set_unit_offset** **(** :ref:`float<class_float>` unit_offset **)**
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
.. _class_PathFollow_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` v_offset **)**
Moves this node in the Y axis, for the same reasons of :ref:`set_h_offset<class_PathFollow_set_h_offset>`.
classes/class_pathfollow2d.rst
+37 -124
View File
@@ -16,38 +16,45 @@ Brief Description
Point sampler for a :ref:`Path2D<class_path2d>`.
Member Functions
Member Variables
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_cubic_interpolation<class_PathFollow2D_get_cubic_interpolation>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_PathFollow2D_get_h_offset>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_PathFollow2D_get_offset>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_unit_offset<class_PathFollow2D_get_unit_offset>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_PathFollow2D_get_v_offset>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_PathFollow2D_has_loop>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_PathFollow2D_is_rotating>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cubic_interpolation<class_PathFollow2D_set_cubic_interpolation>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_PathFollow2D_set_h_offset>` **(** :ref:`float<class_float>` h_offset **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_PathFollow2D_set_loop>` **(** :ref:`bool<class_bool>` loop **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_PathFollow2D_set_offset>` **(** :ref:`float<class_float>` offset **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotate<class_PathFollow2D_set_rotate>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_unit_offset<class_PathFollow2D_set_unit_offset>` **(** :ref:`float<class_float>` unit_offset **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_PathFollow2D_set_v_offset>` **(** :ref:`float<class_float>` v_offset **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
.. _class_PathFollow2D_cubic_interp:
- :ref:`bool<class_bool>` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the :ref:`Curve2D<class_curve2d>` of the :ref:`Path2D<class_path2d>` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
.. _class_PathFollow2D_h_offset:
- :ref:`float<class_float>` **h_offset** - The node's offset along the curve.
.. _class_PathFollow2D_lookahead:
- :ref:`float<class_float>` **lookahead**
.. _class_PathFollow2D_loop:
- :ref:`bool<class_bool>` **loop** - If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
.. _class_PathFollow2D_offset:
- :ref:`float<class_float>` **offset** - The distance along the path in pixels.
.. _class_PathFollow2D_rotate:
- :ref:`bool<class_bool>` **rotate** - If ``true``, this node rotates to follow the path, making its descendants rotate.
.. _class_PathFollow2D_unit_offset:
- :ref:`float<class_float>` **unit_offset** - The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
.. _class_PathFollow2D_v_offset:
- :ref:`float<class_float>` **v_offset** - The node's offset perpendicular to the curve.
Description
-----------
@@ -56,97 +63,3 @@ This node takes its parent :ref:`Path2D<class_path2d>`, and returns the coordina
It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.
Member Function Description
---------------------------
.. _class_PathFollow2D_get_cubic_interpolation:
- :ref:`bool<class_bool>` **get_cubic_interpolation** **(** **)** const
This method returns whether the position between two cached points (see :ref:`set_cubic_interpolation<class_PathFollow2D_set_cubic_interpolation>`) is interpolated linearly, or cubicly.
.. _class_PathFollow2D_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
Returns the horizontal displacement this node has from its parent :ref:`Path2D<class_path2d>`.
.. _class_PathFollow2D_get_offset:
- :ref:`float<class_float>` **get_offset** **(** **)** const
Returns the distance along the path in pixels.
.. _class_PathFollow2D_get_unit_offset:
- :ref:`float<class_float>` **get_unit_offset** **(** **)** const
Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
.. _class_PathFollow2D_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
Returns the vertical displacement this node has from its parent :ref:`Path2D<class_path2d>`.
.. _class_PathFollow2D_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Returns whether this node wraps its offsets around, or truncates them to the path ends.
.. _class_PathFollow2D_is_rotating:
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
Returns whether this node rotates to follow the path.
.. _class_PathFollow2D_set_cubic_interpolation:
- void **set_cubic_interpolation** **(** :ref:`bool<class_bool>` enable **)**
The points along the :ref:`Curve2D<class_curve2d>` of the :ref:`Path2D<class_path2d>` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
This method controls whether the position between two cached points is interpolated linearly, or cubicly.
.. _class_PathFollow2D_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` h_offset **)**
Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
A similar effect may be achieved moving this node's descendants.
.. _class_PathFollow2D_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` loop **)**
If set, any offset outside the path's length (whether set by :ref:`set_offset<class_PathFollow2D_set_offset>` or :ref:`set_unit_offset<class_PathFollow2D_set_unit_offset>` will wrap around, instead of stopping at the ends. Set it for cyclic paths.
.. _class_PathFollow2D_set_offset:
- void **set_offset** **(** :ref:`float<class_float>` offset **)**
Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
.. _class_PathFollow2D_set_rotate:
- void **set_rotate** **(** :ref:`bool<class_bool>` enable **)**
If set, this node rotates to follow the path, making its descendants rotate.
.. _class_PathFollow2D_set_unit_offset:
- void **set_unit_offset** **(** :ref:`float<class_float>` unit_offset **)**
Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
.. _class_PathFollow2D_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` v_offset **)**
Moves the PathFollow2D vertically, for the same reasons of :ref:`set_h_offset<class_PathFollow2D_set_h_offset>`.
classes/class_physics2ddirectbodystate.rst
+44 -112
View File
@@ -21,8 +21,6 @@ Direct access object to a physics body in the :ref:`Physics2DServer<class_physic
Member Functions
----------------
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_angular_velocity<class_Physics2DDirectBodyState_get_angular_velocity>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_contact_collider<class_Physics2DDirectBodyState_get_contact_collider>` **(** :ref:`int<class_int>` contact_idx **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -46,36 +44,54 @@ Member Functions
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_contact_local_shape<class_Physics2DDirectBodyState_get_contact_local_shape>` **(** :ref:`int<class_int>` contact_idx **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_inverse_inertia<class_Physics2DDirectBodyState_get_inverse_inertia>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_inverse_mass<class_Physics2DDirectBodyState_get_inverse_mass>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_linear_velocity<class_Physics2DDirectBodyState_get_linear_velocity>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` | :ref:`get_space_state<class_Physics2DDirectBodyState_get_space_state>` **(** **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Physics2DDirectBodyState_get_step>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_total_angular_damp<class_Physics2DDirectBodyState_get_total_angular_damp>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_total_gravity<class_Physics2DDirectBodyState_get_total_gravity>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_total_linear_damp<class_Physics2DDirectBodyState_get_total_linear_damp>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_Physics2DDirectBodyState_get_transform>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`integrate_forces<class_Physics2DDirectBodyState_integrate_forces>` **(** **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_sleeping<class_Physics2DDirectBodyState_is_sleeping>` **(** **)** const |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_angular_velocity<class_Physics2DDirectBodyState_set_angular_velocity>` **(** :ref:`float<class_float>` velocity **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_velocity<class_Physics2DDirectBodyState_set_linear_velocity>` **(** :ref:`Vector2<class_vector2>` velocity **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sleep_state<class_Physics2DDirectBodyState_set_sleep_state>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_Physics2DDirectBodyState_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
+--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Physics2DDirectBodyState_angular_velocity:
- :ref:`float<class_float>` **angular_velocity** - The angular velocity of the body.
.. _class_Physics2DDirectBodyState_inverse_inertia:
- :ref:`float<class_float>` **inverse_inertia** - The inverse of the inertia of the body.
.. _class_Physics2DDirectBodyState_inverse_mass:
- :ref:`float<class_float>` **inverse_mass** - The inverse of the mass of the body.
.. _class_Physics2DDirectBodyState_linear_velocity:
- :ref:`Vector2<class_vector2>` **linear_velocity** - The linear velocity of the body.
.. _class_Physics2DDirectBodyState_sleeping:
- :ref:`bool<class_bool>` **sleeping** - ``true`` if this body is currently sleeping (not active).
.. _class_Physics2DDirectBodyState_step:
- :ref:`float<class_float>` **step** - The timestep (delta) used for the simulation.
.. _class_Physics2DDirectBodyState_total_angular_damp:
- :ref:`float<class_float>` **total_angular_damp** - The rate at which the body stops rotating, if there are not any other forces moving it.
.. _class_Physics2DDirectBodyState_total_gravity:
- :ref:`Vector2<class_vector2>` **total_gravity** - The total gravity vector being currently applied to this body.
.. _class_Physics2DDirectBodyState_total_linear_damp:
- :ref:`float<class_float>` **total_linear_damp** - The rate at which the body stops moving, if there are not any other forces moving it.
.. _class_Physics2DDirectBodyState_transform:
- :ref:`Transform2D<class_transform2d>` **transform** - The transformation matrix of the body.
Description
-----------
@@ -85,12 +101,6 @@ Direct access object to a physics body in the :ref:`Physics2DServer<class_physic
Member Function Description
---------------------------
.. _class_Physics2DDirectBodyState_get_angular_velocity:
- :ref:`float<class_float>` **get_angular_velocity** **(** **)** const
Return the angular velocity of the body.
.. _class_Physics2DDirectBodyState_get_contact_collider:
- :ref:`RID<class_rid>` **get_contact_collider** **(** :ref:`int<class_int>` contact_idx **)** const
@@ -157,94 +167,16 @@ Return the local position (of this body) of the contact point.
Return the local shape index of the collision.
.. _class_Physics2DDirectBodyState_get_inverse_inertia:
- :ref:`float<class_float>` **get_inverse_inertia** **(** **)** const
Return the inverse of the inertia of the body.
.. _class_Physics2DDirectBodyState_get_inverse_mass:
- :ref:`float<class_float>` **get_inverse_mass** **(** **)** const
Return the inverse of the mass of the body.
.. _class_Physics2DDirectBodyState_get_linear_velocity:
- :ref:`Vector2<class_vector2>` **get_linear_velocity** **(** **)** const
Return the current linear velocity of the body.
.. _class_Physics2DDirectBodyState_get_space_state:
- :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` **get_space_state** **(** **)**
Return the current state of space, useful for queries.
.. _class_Physics2DDirectBodyState_get_step:
- :ref:`float<class_float>` **get_step** **(** **)** const
Return the timestep (delta) used for the simulation.
.. _class_Physics2DDirectBodyState_get_total_angular_damp:
- :ref:`float<class_float>` **get_total_angular_damp** **(** **)** const
Return the rate at which the body stops rotating, if there are not any other forces moving it.
.. _class_Physics2DDirectBodyState_get_total_gravity:
- :ref:`Vector2<class_vector2>` **get_total_gravity** **(** **)** const
Return the total gravity vector being currently applied to this body.
.. _class_Physics2DDirectBodyState_get_total_linear_damp:
- :ref:`float<class_float>` **get_total_linear_damp** **(** **)** const
Return the rate at which the body stops moving, if there are not any other forces moving it.
.. _class_Physics2DDirectBodyState_get_transform:
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
Return the transform matrix of the body.
.. _class_Physics2DDirectBodyState_integrate_forces:
- void **integrate_forces** **(** **)**
Call the built-in force integration code.
.. _class_Physics2DDirectBodyState_is_sleeping:
- :ref:`bool<class_bool>` **is_sleeping** **(** **)** const
Return true if this body is currently sleeping (not active).
.. _class_Physics2DDirectBodyState_set_angular_velocity:
- void **set_angular_velocity** **(** :ref:`float<class_float>` velocity **)**
Change the angular velocity of the body.
.. _class_Physics2DDirectBodyState_set_linear_velocity:
- void **set_linear_velocity** **(** :ref:`Vector2<class_vector2>` velocity **)**
Change the linear velocity of the body.
.. _class_Physics2DDirectBodyState_set_sleep_state:
- void **set_sleep_state** **(** :ref:`bool<class_bool>` enabled **)**
Set the sleeping state of the body, only affects character/rigid bodies.
.. _class_Physics2DDirectBodyState_set_transform:
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
Change the transform matrix of the body.
classes/class_physics2dshapequeryparameters.rst
+31 -99
View File
@@ -19,33 +19,37 @@ Parameters to be sent to a 2D shape physics query.
Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Physics2DShapeQueryParameters_get_collision_layer>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_exclude<class_Physics2DShapeQueryParameters_get_exclude>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin<class_Physics2DShapeQueryParameters_get_margin>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_motion<class_Physics2DShapeQueryParameters_get_motion>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_shape_rid<class_Physics2DShapeQueryParameters_get_shape_rid>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_Physics2DShapeQueryParameters_get_transform>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_layer<class_Physics2DShapeQueryParameters_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exclude<class_Physics2DShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_Physics2DShapeQueryParameters_set_margin>` **(** :ref:`float<class_float>` margin **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_motion<class_Physics2DShapeQueryParameters_set_motion>` **(** :ref:`Vector2<class_vector2>` motion **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_Physics2DShapeQueryParameters_set_shape>` **(** :ref:`Resource<class_resource>` shape **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_rid<class_Physics2DShapeQueryParameters_set_shape_rid>` **(** :ref:`RID<class_rid>` shape **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_Physics2DShapeQueryParameters_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_Physics2DShapeQueryParameters_set_shape>` **(** :ref:`Resource<class_resource>` shape **)** |
+-------+-------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Physics2DShapeQueryParameters_collision_layer:
- :ref:`int<class_int>` **collision_layer** - The physics layer the query should be made on.
.. _class_Physics2DShapeQueryParameters_exclude:
- :ref:`Array<class_array>` **exclude** - The list of objects or object :ref:`RID<class_rid>`\ s, that will be excluded from collisions.
.. _class_Physics2DShapeQueryParameters_margin:
- :ref:`float<class_float>` **margin** - The collision margin for the shape.
.. _class_Physics2DShapeQueryParameters_motion:
- :ref:`Vector2<class_vector2>` **motion** - The motion of the shape being queried for.
.. _class_Physics2DShapeQueryParameters_shape_rid:
- :ref:`RID<class_rid>` **shape_rid** - The :ref:`RID<class_rid>` of the queried shape. See :ref:`set_shape<class_Physics2DShapeQueryParameters_set_shape>` also.
.. _class_Physics2DShapeQueryParameters_transform:
- :ref:`Transform2D<class_transform2d>` **transform** - the transform matrix of the queried shape.
Description
-----------
@@ -55,82 +59,10 @@ This class contains the shape and other parameters for intersection/collision qu
Member Function Description
---------------------------
.. _class_Physics2DShapeQueryParameters_get_collision_layer:
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
Return the physics layer the shape belongs to.
.. _class_Physics2DShapeQueryParameters_get_exclude:
- :ref:`Array<class_array>` **get_exclude** **(** **)** const
Return the list of objects, or object :ref:`RID<class_rid>`\ s, that will be excluded from collisions.
.. _class_Physics2DShapeQueryParameters_get_margin:
- :ref:`float<class_float>` **get_margin** **(** **)** const
Return the collision margin for the shape.
.. _class_Physics2DShapeQueryParameters_get_motion:
- :ref:`Vector2<class_vector2>` **get_motion** **(** **)** const
Return the current movement speed of the shape.
.. _class_Physics2DShapeQueryParameters_get_shape_rid:
- :ref:`RID<class_rid>` **get_shape_rid** **(** **)** const
Return the :ref:`RID<class_rid>` of the shape queried.
.. _class_Physics2DShapeQueryParameters_get_transform:
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
Return the transform matrix of the shape queried.
.. _class_Physics2DShapeQueryParameters_set_collision_layer:
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
Set the physics layer the shape belongs to.
.. _class_Physics2DShapeQueryParameters_set_exclude:
- void **set_exclude** **(** :ref:`Array<class_array>` exclude **)**
Set the list of objects, or object :ref:`RID<class_rid>`\ s, that will be excluded from collisions.
.. _class_Physics2DShapeQueryParameters_set_margin:
- void **set_margin** **(** :ref:`float<class_float>` margin **)**
Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
.. _class_Physics2DShapeQueryParameters_set_motion:
- void **set_motion** **(** :ref:`Vector2<class_vector2>` motion **)**
Set the current movement speed of the shape.
.. _class_Physics2DShapeQueryParameters_set_shape:
- void **set_shape** **(** :ref:`Resource<class_resource>` shape **)**
Set the :ref:`Shape2D<class_shape2d>` that will be used for collision/intersection queries.
.. _class_Physics2DShapeQueryParameters_set_shape_rid:
- void **set_shape_rid** **(** :ref:`RID<class_rid>` shape **)**
Set the :ref:`RID<class_rid>` of the shape to be used in queries.
.. _class_Physics2DShapeQueryParameters_set_transform:
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale.
classes/class_physics2dtestmotionresult.rst
+19 -42
View File
@@ -16,66 +16,43 @@ Brief Description
Member Functions
Member Variables
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_collider<class_Physics2DTestMotionResult_get_collider>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collider_id<class_Physics2DTestMotionResult_get_collider_id>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_collider_rid<class_Physics2DTestMotionResult_get_collider_rid>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_Physics2DTestMotionResult_get_collider_shape>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collider_velocity<class_Physics2DTestMotionResult_get_collider_velocity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_Physics2DTestMotionResult_get_collision_normal>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_point<class_Physics2DTestMotionResult_get_collision_point>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_motion<class_Physics2DTestMotionResult_get_motion>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_motion_remainder<class_Physics2DTestMotionResult_get_motion_remainder>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------+
.. _class_Physics2DTestMotionResult_collider:
Member Function Description
---------------------------
- :ref:`Object<class_object>` **collider**
.. _class_Physics2DTestMotionResult_get_collider:
.. _class_Physics2DTestMotionResult_collider_id:
- :ref:`Object<class_object>` **get_collider** **(** **)** const
- :ref:`int<class_int>` **collider_id**
.. _class_Physics2DTestMotionResult_get_collider_id:
.. _class_Physics2DTestMotionResult_collider_rid:
- :ref:`int<class_int>` **get_collider_id** **(** **)** const
- :ref:`RID<class_rid>` **collider_rid**
.. _class_Physics2DTestMotionResult_get_collider_rid:
.. _class_Physics2DTestMotionResult_collider_shape:
- :ref:`RID<class_rid>` **get_collider_rid** **(** **)** const
- :ref:`int<class_int>` **collider_shape**
.. _class_Physics2DTestMotionResult_get_collider_shape:
.. _class_Physics2DTestMotionResult_collider_velocity:
- :ref:`int<class_int>` **get_collider_shape** **(** **)** const
- :ref:`Vector2<class_vector2>` **collider_velocity**
.. _class_Physics2DTestMotionResult_get_collider_velocity:
.. _class_Physics2DTestMotionResult_collision_normal:
- :ref:`Vector2<class_vector2>` **get_collider_velocity** **(** **)** const
- :ref:`Vector2<class_vector2>` **collision_normal**
.. _class_Physics2DTestMotionResult_get_collision_normal:
.. _class_Physics2DTestMotionResult_collision_point:
- :ref:`Vector2<class_vector2>` **get_collision_normal** **(** **)** const
- :ref:`Vector2<class_vector2>` **collision_point**
.. _class_Physics2DTestMotionResult_get_collision_point:
.. _class_Physics2DTestMotionResult_motion:
- :ref:`Vector2<class_vector2>` **get_collision_point** **(** **)** const
- :ref:`Vector2<class_vector2>` **motion**
.. _class_Physics2DTestMotionResult_get_motion:
.. _class_Physics2DTestMotionResult_motion_remainder:
- :ref:`Vector2<class_vector2>` **get_motion** **(** **)** const
.. _class_Physics2DTestMotionResult_get_motion_remainder:
- :ref:`Vector2<class_vector2>` **get_motion_remainder** **(** **)** const
- :ref:`Vector2<class_vector2>` **motion_remainder**
classes/class_physicsdirectbodystate.rst
+52 -96
View File
@@ -28,10 +28,6 @@ Member Functions
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_torqe_impulse<class_PhysicsDirectBodyState_apply_torqe_impulse>` **(** :ref:`Vector3<class_vector3>` j **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_angular_velocity<class_PhysicsDirectBodyState_get_angular_velocity>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_center_of_mass<class_PhysicsDirectBodyState_get_center_of_mass>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_contact_collider<class_PhysicsDirectBodyState_get_contact_collider>` **(** :ref:`int<class_int>` contact_idx **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_contact_collider_id<class_PhysicsDirectBodyState_get_contact_collider_id>` **(** :ref:`int<class_int>` contact_idx **)** const |
@@ -52,38 +48,62 @@ Member Functions
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_contact_local_shape<class_PhysicsDirectBodyState_get_contact_local_shape>` **(** :ref:`int<class_int>` contact_idx **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_inverse_inertia<class_PhysicsDirectBodyState_get_inverse_inertia>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_inverse_mass<class_PhysicsDirectBodyState_get_inverse_mass>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_linear_velocity<class_PhysicsDirectBodyState_get_linear_velocity>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_basis>` | :ref:`get_principal_inertia_axes<class_PhysicsDirectBodyState_get_principal_inertia_axes>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`get_space_state<class_PhysicsDirectBodyState_get_space_state>` **(** **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_PhysicsDirectBodyState_get_step>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_total_angular_damp<class_PhysicsDirectBodyState_get_total_angular_damp>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_total_gravity<class_PhysicsDirectBodyState_get_total_gravity>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_total_linear_damp<class_PhysicsDirectBodyState_get_total_linear_damp>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_PhysicsDirectBodyState_get_transform>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`integrate_forces<class_PhysicsDirectBodyState_integrate_forces>` **(** **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_sleeping<class_PhysicsDirectBodyState_is_sleeping>` **(** **)** const |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_angular_velocity<class_PhysicsDirectBodyState_set_angular_velocity>` **(** :ref:`Vector3<class_vector3>` velocity **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_velocity<class_PhysicsDirectBodyState_set_linear_velocity>` **(** :ref:`Vector3<class_vector3>` velocity **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sleep_state<class_PhysicsDirectBodyState_set_sleep_state>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_PhysicsDirectBodyState_set_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PhysicsDirectBodyState_angular_velocity:
- :ref:`Vector3<class_vector3>` **angular_velocity** - The angular velocity of the body.
.. _class_PhysicsDirectBodyState_center_of_mass:
- :ref:`Vector3<class_vector3>` **center_of_mass**
.. _class_PhysicsDirectBodyState_inverse_inertia:
- :ref:`Vector3<class_vector3>` **inverse_inertia** - The inverse of the inertia of the body.
.. _class_PhysicsDirectBodyState_inverse_mass:
- :ref:`float<class_float>` **inverse_mass** - The inverse of the mass of the body.
.. _class_PhysicsDirectBodyState_linear_velocity:
- :ref:`Vector3<class_vector3>` **linear_velocity** - The linear velocity of the body.
.. _class_PhysicsDirectBodyState_principal_inertia_axes:
- :ref:`Basis<class_basis>` **principal_inertia_axes**
.. _class_PhysicsDirectBodyState_sleeping:
- :ref:`bool<class_bool>` **sleeping** - ``true`` if this body is currently sleeping (not active).
.. _class_PhysicsDirectBodyState_step:
- :ref:`float<class_float>` **step** - The timestep (delta) used for the simulation.
.. _class_PhysicsDirectBodyState_total_angular_damp:
- :ref:`float<class_float>` **total_angular_damp** - The rate at which the body stops rotating, if there are not any other forces moving it.
.. _class_PhysicsDirectBodyState_total_gravity:
- :ref:`Vector3<class_vector3>` **total_gravity** - The total gravity vector being currently applied to this body.
.. _class_PhysicsDirectBodyState_total_linear_damp:
- :ref:`float<class_float>` **total_linear_damp** - The rate at which the body stops moving, if there are not any other forces moving it.
.. _class_PhysicsDirectBodyState_transform:
- :ref:`Transform<class_transform>` **transform** - The transformation matrix of the body.
Member Function Description
---------------------------
@@ -100,14 +120,6 @@ Member Function Description
- void **apply_torqe_impulse** **(** :ref:`Vector3<class_vector3>` j **)**
.. _class_PhysicsDirectBodyState_get_angular_velocity:
- :ref:`Vector3<class_vector3>` **get_angular_velocity** **(** **)** const
.. _class_PhysicsDirectBodyState_get_center_of_mass:
- :ref:`Vector3<class_vector3>` **get_center_of_mass** **(** **)** const
.. _class_PhysicsDirectBodyState_get_contact_collider:
- :ref:`RID<class_rid>` **get_contact_collider** **(** :ref:`int<class_int>` contact_idx **)** const
@@ -148,68 +160,12 @@ Member Function Description
- :ref:`int<class_int>` **get_contact_local_shape** **(** :ref:`int<class_int>` contact_idx **)** const
.. _class_PhysicsDirectBodyState_get_inverse_inertia:
- :ref:`Vector3<class_vector3>` **get_inverse_inertia** **(** **)** const
.. _class_PhysicsDirectBodyState_get_inverse_mass:
- :ref:`float<class_float>` **get_inverse_mass** **(** **)** const
.. _class_PhysicsDirectBodyState_get_linear_velocity:
- :ref:`Vector3<class_vector3>` **get_linear_velocity** **(** **)** const
.. _class_PhysicsDirectBodyState_get_principal_inertia_axes:
- :ref:`Basis<class_basis>` **get_principal_inertia_axes** **(** **)** const
.. _class_PhysicsDirectBodyState_get_space_state:
- :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **get_space_state** **(** **)**
.. _class_PhysicsDirectBodyState_get_step:
- :ref:`float<class_float>` **get_step** **(** **)** const
.. _class_PhysicsDirectBodyState_get_total_angular_damp:
- :ref:`float<class_float>` **get_total_angular_damp** **(** **)** const
.. _class_PhysicsDirectBodyState_get_total_gravity:
- :ref:`Vector3<class_vector3>` **get_total_gravity** **(** **)** const
.. _class_PhysicsDirectBodyState_get_total_linear_damp:
- :ref:`float<class_float>` **get_total_linear_damp** **(** **)** const
.. _class_PhysicsDirectBodyState_get_transform:
- :ref:`Transform<class_transform>` **get_transform** **(** **)** const
.. _class_PhysicsDirectBodyState_integrate_forces:
- void **integrate_forces** **(** **)**
.. _class_PhysicsDirectBodyState_is_sleeping:
- :ref:`bool<class_bool>` **is_sleeping** **(** **)** const
.. _class_PhysicsDirectBodyState_set_angular_velocity:
- void **set_angular_velocity** **(** :ref:`Vector3<class_vector3>` velocity **)**
.. _class_PhysicsDirectBodyState_set_linear_velocity:
- void **set_linear_velocity** **(** :ref:`Vector3<class_vector3>` velocity **)**
.. _class_PhysicsDirectBodyState_set_sleep_state:
- void **set_sleep_state** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_PhysicsDirectBodyState_set_transform:
- void **set_transform** **(** :ref:`Transform<class_transform>` transform **)**
classes/class_physicsshapequeryparameters.rst
+27 -63
View File
@@ -19,75 +19,39 @@ Brief Description
Member Functions
----------------
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_PhysicsShapeQueryParameters_get_collision_mask>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_exclude<class_PhysicsShapeQueryParameters_get_exclude>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin<class_PhysicsShapeQueryParameters_get_margin>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_shape_rid<class_PhysicsShapeQueryParameters_get_shape_rid>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_PhysicsShapeQueryParameters_get_transform>` **(** **)** const |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask<class_PhysicsShapeQueryParameters_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exclude<class_PhysicsShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_PhysicsShapeQueryParameters_set_margin>` **(** :ref:`float<class_float>` margin **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_PhysicsShapeQueryParameters_set_shape>` **(** :ref:`Resource<class_resource>` shape **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_rid<class_PhysicsShapeQueryParameters_set_shape_rid>` **(** :ref:`RID<class_rid>` shape **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_PhysicsShapeQueryParameters_set_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
+-------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_PhysicsShapeQueryParameters_set_shape>` **(** :ref:`Resource<class_resource>` shape **)** |
+-------+-----------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PhysicsShapeQueryParameters_collision_mask:
- :ref:`int<class_int>` **collision_mask**
.. _class_PhysicsShapeQueryParameters_exclude:
- :ref:`Array<class_array>` **exclude**
.. _class_PhysicsShapeQueryParameters_margin:
- :ref:`float<class_float>` **margin**
.. _class_PhysicsShapeQueryParameters_shape_rid:
- :ref:`RID<class_rid>` **shape_rid**
.. _class_PhysicsShapeQueryParameters_transform:
- :ref:`Transform<class_transform>` **transform**
Member Function Description
---------------------------
.. _class_PhysicsShapeQueryParameters_get_collision_mask:
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
.. _class_PhysicsShapeQueryParameters_get_exclude:
- :ref:`Array<class_array>` **get_exclude** **(** **)** const
.. _class_PhysicsShapeQueryParameters_get_margin:
- :ref:`float<class_float>` **get_margin** **(** **)** const
.. _class_PhysicsShapeQueryParameters_get_shape_rid:
- :ref:`RID<class_rid>` **get_shape_rid** **(** **)** const
.. _class_PhysicsShapeQueryParameters_get_transform:
- :ref:`Transform<class_transform>` **get_transform** **(** **)** const
.. _class_PhysicsShapeQueryParameters_set_collision_mask:
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
.. _class_PhysicsShapeQueryParameters_set_exclude:
- void **set_exclude** **(** :ref:`Array<class_array>` exclude **)**
.. _class_PhysicsShapeQueryParameters_set_margin:
- void **set_margin** **(** :ref:`float<class_float>` margin **)**
.. _class_PhysicsShapeQueryParameters_set_shape:
- void **set_shape** **(** :ref:`Resource<class_resource>` shape **)**
.. _class_PhysicsShapeQueryParameters_set_shape_rid:
- void **set_shape_rid** **(** :ref:`RID<class_rid>` shape **)**
.. _class_PhysicsShapeQueryParameters_set_transform:
- void **set_transform** **(** :ref:`Transform<class_transform>` transform **)**
classes/class_polygon2d.rst
+5 -26
View File
@@ -16,15 +16,6 @@ Brief Description
A 2D polygon.
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_texture_rotation<class_Polygon2D_get_texture_rotation>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_rotation<class_Polygon2D_set_texture_rotation>` **(** :ref:`float<class_float>` texture_rotation **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -62,7 +53,11 @@ Member Variables
.. _class_Polygon2D_texture_rotation:
- :ref:`float<class_float>` **texture_rotation** - The texture's rotation in degrees.
- :ref:`float<class_float>` **texture_rotation** - The texture's rotation in radians.
.. _class_Polygon2D_texture_rotation_degrees:
- :ref:`float<class_float>` **texture_rotation_degrees** - The texture's rotation in degrees.
.. _class_Polygon2D_texture_scale:
@@ -82,19 +77,3 @@ Description
A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.
Member Function Description
---------------------------
.. _class_Polygon2D_get_texture_rotation:
- :ref:`float<class_float>` **get_texture_rotation** **(** **)** const
Return the rotation in radians of the texture polygon.
.. _class_Polygon2D_set_texture_rotation:
- void **set_texture_rotation** **(** :ref:`float<class_float>` texture_rotation **)**
Set the amount of rotation of the polygon texture, ``texture_rotation`` is specified in radians and clockwise rotation.
classes/class_popupmenu.rst
+4 -12
View File
@@ -62,8 +62,6 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_item_tooltip<class_PopupMenu_get_item_tooltip>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hide_on_state_item_selection<class_PopupMenu_is_hide_on_state_item_selection>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_checkable<class_PopupMenu_is_item_checkable>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_item_checked<class_PopupMenu_is_item_checked>` **(** :ref:`int<class_int>` idx **)** const |
@@ -74,8 +72,6 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_item<class_PopupMenu_remove_item>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_on_state_item_selection<class_PopupMenu_set_hide_on_state_item_selection>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_accelerator<class_PopupMenu_set_item_accelerator>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` accel **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_as_checkable<class_PopupMenu_set_item_as_checkable>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable **)** |
@@ -134,6 +130,10 @@ Member Variables
- :ref:`bool<class_bool>` **hide_on_item_selection**
.. _class_PopupMenu_hide_on_state_item_selection:
- :ref:`bool<class_bool>` **hide_on_state_item_selection**
Description
-----------
@@ -259,10 +259,6 @@ Return the text of the item at index "idx".
- :ref:`String<class_string>` **get_item_tooltip** **(** :ref:`int<class_int>` idx **)** const
.. _class_PopupMenu_is_hide_on_state_item_selection:
- :ref:`bool<class_bool>` **is_hide_on_state_item_selection** **(** **)** const
.. _class_PopupMenu_is_item_checkable:
- :ref:`bool<class_bool>` **is_item_checkable** **(** :ref:`int<class_int>` idx **)** const
@@ -293,10 +289,6 @@ Return whether the item is a seperator. If it is, it would be displayed as a lin
Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one.
.. _class_PopupMenu_set_hide_on_state_item_selection:
- void **set_hide_on_state_item_selection** **(** :ref:`bool<class_bool>` enable **)**
.. _class_PopupMenu_set_item_accelerator:
- void **set_item_accelerator** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` accel **)**
classes/class_proximitygroup.rst
+19 -12
View File
@@ -22,10 +22,6 @@ Member Functions
+-------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`broadcast<class_ProximityGroup_broadcast>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dispatch_mode<class_ProximityGroup_set_dispatch_mode>` **(** :ref:`int<class_int>` mode **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_group_name<class_ProximityGroup_set_group_name>` **(** :ref:`String<class_string>` name **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -38,10 +34,29 @@ Signals
Member Variables
----------------
.. _class_ProximityGroup_dispatch_mode:
- :ref:`DispatchMode<enum_proximitygroup_dispatchmode>` **dispatch_mode**
.. _class_ProximityGroup_grid_radius:
- :ref:`Vector3<class_vector3>` **grid_radius**
.. _class_ProximityGroup_group_name:
- :ref:`String<class_string>` **group_name**
Enums
-----
.. _enum_ProximityGroup_DispatchMode:
enum **DispatchMode**
- **MODE_PROXY** = **0**
- **MODE_SIGNAL** = **1**
Description
-----------
@@ -55,12 +70,4 @@ Member Function Description
- void **broadcast** **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` parameters **)**
.. _class_ProximityGroup_set_dispatch_mode:
- void **set_dispatch_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_ProximityGroup_set_group_name:
- void **set_group_name** **(** :ref:`String<class_string>` name **)**
classes/class_range.rst
+9 -21
View File
@@ -21,15 +21,11 @@ Abstract base class for range-based controls.
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_as_ratio<class_Range_get_as_ratio>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------+
| void | :ref:`set_as_ratio<class_Range_set_as_ratio>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+-------------------------------------------------------------------------------------------+
| void | :ref:`share<class_Range_share>` **(** :ref:`Node<class_node>` with **)** |
+----------------------------+-------------------------------------------------------------------------------------------+
| void | :ref:`unshare<class_Range_unshare>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------+
+-------+--------------------------------------------------------------------------+
| void | :ref:`share<class_Range_share>` **(** :ref:`Node<class_node>` with **)** |
+-------+--------------------------------------------------------------------------+
| void | :ref:`unshare<class_Range_unshare>` **(** **)** |
+-------+--------------------------------------------------------------------------+
Signals
-------
@@ -66,6 +62,10 @@ Member Variables
- :ref:`float<class_float>` **page** - Page size. Used mainly for :ref:`ScrollBar<class_scrollbar>`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``.
.. _class_Range_ratio:
- :ref:`float<class_float>` **ratio** - The value mapped between 0 and 1.
.. _class_Range_rounded:
- :ref:`bool<class_bool>` **rounded** - If ``true``, ``value`` will always be rounded to the nearest integer.
@@ -87,18 +87,6 @@ Range is a base class for :ref:`Control<class_control>` nodes that change a floa
Member Function Description
---------------------------
.. _class_Range_get_as_ratio:
- :ref:`float<class_float>` **get_as_ratio** **(** **)** const
Return value mapped to 0 to 1 range.
.. _class_Range_set_as_ratio:
- void **set_as_ratio** **(** :ref:`float<class_float>` value **)**
Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
.. _class_Range_share:
- void **share** **(** :ref:`Node<class_node>` with **)**
classes/class_regexmatch.rst
+25 -33
View File
@@ -19,21 +19,31 @@ Contains the results of a regex search.
Member Functions
----------------
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_end<class_RegExMatch_get_end>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_group_count<class_RegExMatch_get_group_count>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_names<class_RegExMatch_get_names>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_start<class_RegExMatch_get_start>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_string<class_RegExMatch_get_string>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_strings<class_RegExMatch_get_strings>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_subject<class_RegExMatch_get_subject>` **(** **)** const |
+--------------------------------------+-------------------------------------------------------------------------------------------------------+
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_end<class_RegExMatch_get_end>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_group_count<class_RegExMatch_get_group_count>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_start<class_RegExMatch_get_start>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_string<class_RegExMatch_get_string>` **(** :ref:`Variant<class_variant>` name=0 **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_RegExMatch_names:
- :ref:`Dictionary<class_dictionary>` **names** - A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.
.. _class_RegExMatch_strings:
- :ref:`Array<class_array>` **strings** - An :ref:`Array<class_array>` of the match and its capturing groups.
.. _class_RegExMatch_subject:
- :ref:`String<class_string>` **subject** - The source string used with the search pattern to find this matching result.
Description
-----------
@@ -57,12 +67,6 @@ Returns -1 if the group did not match or doesn't exist.
Returns the number of capturing groups.
.. _class_RegExMatch_get_names:
- :ref:`Dictionary<class_dictionary>` **get_names** **(** **)** const
Returns a dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.
.. _class_RegExMatch_get_start:
- :ref:`int<class_int>` **get_start** **(** :ref:`Variant<class_variant>` name=0 **)** const
@@ -79,16 +83,4 @@ Returns the substring of the match from the source string. Capturing groups can
Returns an empty string if the group did not match or doesn't exist.
.. _class_RegExMatch_get_strings:
- :ref:`Array<class_array>` **get_strings** **(** **)** const
Returns an :ref:`Array<class_array>` of the match and its capturing groups.
.. _class_RegExMatch_get_subject:
- :ref:`String<class_string>` **get_subject** **(** **)** const
Returns the source string used with the search pattern to find this matching result.
classes/class_richtextlabel.rst
+26 -96
View File
@@ -30,24 +30,12 @@ Member Functions
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_line_count<class_RichTextLabel_get_line_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_size<class_RichTextLabel_get_tab_size>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_RichTextLabel_get_text>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_total_character_count<class_RichTextLabel_get_total_character_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`VScrollBar<class_vscrollbar>` | :ref:`get_v_scroll<class_RichTextLabel_get_v_scroll>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_line_count<class_RichTextLabel_get_visible_line_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_meta_underlined<class_RichTextLabel_is_meta_underlined>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scroll_active<class_RichTextLabel_is_scroll_active>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_scroll_following<class_RichTextLabel_is_scroll_following>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selection_enabled<class_RichTextLabel_is_selection_enabled>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`newline<class_RichTextLabel_newline>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`parse_bbcode<class_RichTextLabel_parse_bbcode>` **(** :ref:`String<class_string>` bbcode **)** |
@@ -76,20 +64,8 @@ Member Functions
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`scroll_to_line<class_RichTextLabel_scroll_to_line>` **(** :ref:`int<class_int>` line **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_meta_underline<class_RichTextLabel_set_meta_underline>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_active<class_RichTextLabel_set_scroll_active>` **(** :ref:`bool<class_bool>` active **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_follow<class_RichTextLabel_set_scroll_follow>` **(** :ref:`bool<class_bool>` follow **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selection_enabled<class_RichTextLabel_set_selection_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_size<class_RichTextLabel_set_tab_size>` **(** :ref:`int<class_int>` spaces **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_table_column_expand<class_RichTextLabel_set_table_column_expand>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_RichTextLabel_set_text>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -124,6 +100,10 @@ Member Variables
- :ref:`String<class_string>` **bbcode_text** - The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.
.. _class_RichTextLabel_meta_underlined:
- :ref:`bool<class_bool>` **meta_underlined** - If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``.
.. _class_RichTextLabel_override_selected_font_color:
- :ref:`bool<class_bool>` **override_selected_font_color** - If ``true`` the label uses the custom font color. Default value: ``false``.
@@ -132,6 +112,28 @@ Member Variables
- :ref:`float<class_float>` **percent_visible** - The text's visibility, as a :ref:`float<class_float>` between 0.0 and 1.0.
.. _class_RichTextLabel_scroll_active:
- :ref:`bool<class_bool>` **scroll_active** - If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line<class_RichTextLabel_scroll_to_line>`. Default value: ``true``.
.. _class_RichTextLabel_scroll_following:
- :ref:`bool<class_bool>` **scroll_following** - If ``true``, the window scrolls down to display new content automatically. Default value: ``false``.
.. _class_RichTextLabel_selection_enabled:
- :ref:`bool<class_bool>` **selection_enabled** - If ``true``, the label allows text selection.
.. _class_RichTextLabel_tab_size:
- :ref:`int<class_int>` **tab_size** - The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
.. _class_RichTextLabel_text:
- :ref:`String<class_string>` **text** - The raw text of the label.
When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text<class_RichTextLabel_bbcode_text>`.
.. _class_RichTextLabel_visible_characters:
- :ref:`int<class_int>` **visible_characters** - The restricted number of characters to display in the label.
@@ -215,18 +217,6 @@ Clears the tag stack and sets :ref:`bbcode_text<class_RichTextLabel_bbcode_text>
Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line.
.. _class_RichTextLabel_get_tab_size:
- :ref:`int<class_int>` **get_tab_size** **(** **)** const
Returns the number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
.. _class_RichTextLabel_get_text:
- :ref:`String<class_string>` **get_text** **(** **)**
Returns the raw content of :ref:`bbcode_text<class_RichTextLabel_bbcode_text>`.
.. _class_RichTextLabel_get_total_character_count:
- :ref:`int<class_int>` **get_total_character_count** **(** **)** const
@@ -245,30 +235,6 @@ Returns the vertical scrollbar.
Returns the number of visible lines.
.. _class_RichTextLabel_is_meta_underlined:
- :ref:`bool<class_bool>` **is_meta_underlined** **(** **)** const
Returns ``true`` if the label underlines meta tags such as url{text}.
.. _class_RichTextLabel_is_scroll_active:
- :ref:`bool<class_bool>` **is_scroll_active** **(** **)** const
Returns ``true`` if the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line<class_RichTextLabel_scroll_to_line>`.
.. _class_RichTextLabel_is_scroll_following:
- :ref:`bool<class_bool>` **is_scroll_following** **(** **)** const
Returns ``true`` if the window scrolls down to display new content automatically.
.. _class_RichTextLabel_is_selection_enabled:
- :ref:`bool<class_bool>` **is_selection_enabled** **(** **)** const
Returns ``true`` if the label allows text selection.
.. _class_RichTextLabel_newline:
- void **newline** **(** **)**
@@ -353,36 +319,6 @@ Removes a line of content from the label. Returns ``true`` if the line exists.
Scrolls the window's top line to match ``line``.
.. _class_RichTextLabel_set_meta_underline:
- void **set_meta_underline** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` will underline meta tags such as the url bbcode. Default value: ``true``.
.. _class_RichTextLabel_set_scroll_active:
- void **set_scroll_active** **(** :ref:`bool<class_bool>` active **)**
If ``false`` the vertical scrollbar is hidden. Default value: ``true``.
.. _class_RichTextLabel_set_scroll_follow:
- void **set_scroll_follow** **(** :ref:`bool<class_bool>` follow **)**
If ``true`` the window scrolls to reveal new content. Default value: ``false``.
.. _class_RichTextLabel_set_selection_enabled:
- void **set_selection_enabled** **(** :ref:`bool<class_bool>` enabled **)**
If ``true`` text can be selected.
.. _class_RichTextLabel_set_tab_size:
- void **set_tab_size** **(** :ref:`int<class_int>` spaces **)**
Sets the current tab length in spaces. Use with :ref:`push_indent<class_RichTextLabel_push_indent>` to redefine indent length.
.. _class_RichTextLabel_set_table_column_expand:
- void **set_table_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand, :ref:`int<class_int>` ratio **)**
@@ -393,10 +329,4 @@ For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width wou
Columns with a ``false`` expand will not contribute to the total ratio.
.. _class_RichTextLabel_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
Clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text<class_RichTextLabel_bbcode_text>`.
classes/class_rigidbody2d.rst
+25 -61
View File
@@ -19,31 +19,19 @@ A body that is controlled by the 2D physics engine.
Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_integrate_forces<class_RigidBody2D__integrate_forces>` **(** :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>` state **)** virtual |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_force<class_RigidBody2D_add_force>` **(** :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` force **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_impulse<class_RigidBody2D_apply_impulse>` **(** :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` impulse **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_applied_force<class_RigidBody2D_get_applied_force>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_applied_torque<class_RigidBody2D_get_applied_torque>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_colliding_bodies<class_RigidBody2D_get_colliding_bodies>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_inertia<class_RigidBody2D_get_inertia>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_applied_force<class_RigidBody2D_set_applied_force>` **(** :ref:`Vector2<class_vector2>` force **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_applied_torque<class_RigidBody2D_set_applied_torque>` **(** :ref:`float<class_float>` torque **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_velocity<class_RigidBody2D_set_axis_velocity>` **(** :ref:`Vector2<class_vector2>` axis_velocity **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_inertia<class_RigidBody2D_set_inertia>` **(** :ref:`float<class_float>` inertia **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_motion<class_RigidBody2D_test_motion>` **(** :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_integrate_forces<class_RigidBody2D__integrate_forces>` **(** :ref:`Physics2DDirectBodyState<class_physics2ddirectbodystate>` state **)** virtual |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_force<class_RigidBody2D_add_force>` **(** :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` force **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_impulse<class_RigidBody2D_apply_impulse>` **(** :ref:`Vector2<class_vector2>` offset, :ref:`Vector2<class_vector2>` impulse **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_colliding_bodies<class_RigidBody2D_get_colliding_bodies>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_velocity<class_RigidBody2D_set_axis_velocity>` **(** :ref:`Vector2<class_vector2>` axis_velocity **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_motion<class_RigidBody2D_test_motion>` **(** :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -90,6 +78,14 @@ Member Variables
- :ref:`float<class_float>` **angular_velocity** - The body's rotational velocity.
.. _class_RigidBody2D_applied_force:
- :ref:`Vector2<class_vector2>` **applied_force** - The body's total applied force.
.. _class_RigidBody2D_applied_torque:
- :ref:`float<class_float>` **applied_torque** - The body's total applied torque.
.. _class_RigidBody2D_bounce:
- :ref:`float<class_float>` **bounce** - The body's bounciness. Default value: ``0``.
@@ -124,6 +120,10 @@ Continuous collision detection tries to predict where a moving body will collide
- :ref:`float<class_float>` **gravity_scale** - Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by :ref:`Area2D<class_area2d>`\ s. Default value: ``1``.
.. _class_RigidBody2D_inertia:
- :ref:`float<class_float>` **inertia** - The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
.. _class_RigidBody2D_linear_damp:
- :ref:`float<class_float>` **linear_damp** - Damps the body's :ref:`linear_velocity<class_RigidBody2D_linear_velocity>`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``.
@@ -210,54 +210,18 @@ Adds a positioned force to the body. Both the force and the offset from the body
Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates.
.. _class_RigidBody2D_get_applied_force:
- :ref:`Vector2<class_vector2>` **get_applied_force** **(** **)** const
Returns the body's total applied force.
.. _class_RigidBody2D_get_applied_torque:
- :ref:`float<class_float>` **get_applied_torque** **(** **)** const
Returns the body's total applied torque.
.. _class_RigidBody2D_get_colliding_bodies:
- :ref:`Array<class_array>` **get_colliding_bodies** **(** **)** const
Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported<class_RigidBody2D_contacts_reported>` to set the maximum number reported. You must also set :ref:`contact_monitor<class_RigidBody2D_contact_monitor>` to ``true``. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
.. _class_RigidBody2D_get_inertia:
- :ref:`float<class_float>` **get_inertia** **(** **)** const
Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned :ref:`Shape2D<class_shape2d>`\ s during the physics frame. Note that it will not yet have a value in the ``_ready()`` function.
.. _class_RigidBody2D_set_applied_force:
- void **set_applied_force** **(** :ref:`Vector2<class_vector2>` force **)**
Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly.
.. _class_RigidBody2D_set_applied_torque:
- void **set_applied_torque** **(** :ref:`float<class_float>` torque **)**
Sets the applied torque.
.. _class_RigidBody2D_set_axis_velocity:
- void **set_axis_velocity** **(** :ref:`Vector2<class_vector2>` axis_velocity **)**
Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
.. _class_RigidBody2D_set_inertia:
- void **set_inertia** **(** :ref:`float<class_float>` inertia **)**
Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.
.. _class_RigidBody2D_test_motion:
- :ref:`bool<class_bool>` **test_motion** **(** :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=null **)**
classes/class_scenetree.rst
+40 -98
View File
@@ -30,10 +30,6 @@ Member Functions
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SceneTreeTimer<class_scenetreetimer>` | :ref:`create_timer<class_SceneTree_create_timer>` **(** :ref:`float<class_float>` time_sec, :ref:`bool<class_bool>` pause_mode_process=true **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_current_scene<class_SceneTree_get_current_scene>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`get_edited_scene_root<class_SceneTree_get_edited_scene_root>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frame<class_SceneTree_get_frame>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_network_connected_peers<class_SceneTree_get_network_connected_peers>` **(** **)** const |
@@ -44,28 +40,16 @@ Member Functions
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_nodes_in_group<class_SceneTree_get_nodes_in_group>` **(** :ref:`String<class_string>` group **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Viewport<class_viewport>` | :ref:`get_root<class_SceneTree_get_root>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_rpc_sender_id<class_SceneTree_get_rpc_sender_id>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_group<class_SceneTree_has_group>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_network_peer<class_SceneTree_has_network_peer>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debugging_collisions_hint<class_SceneTree_is_debugging_collisions_hint>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debugging_navigation_hint<class_SceneTree_is_debugging_navigation_hint>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_input_handled<class_SceneTree_is_input_handled>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_network_server<class_SceneTree_is_network_server>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_SceneTree_is_paused>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_refusing_new_network_connections<class_SceneTree_is_refusing_new_network_connections>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_font_oversampling<class_SceneTree_is_using_font_oversampling>` **(** **)** const |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`notify_group<class_SceneTree_notify_group>` **(** :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`notify_group_flags<class_SceneTree_notify_group_flags>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)** |
@@ -78,32 +62,16 @@ Member Functions
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_auto_accept_quit<class_SceneTree_set_auto_accept_quit>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_scene<class_SceneTree_set_current_scene>` **(** :ref:`Node<class_node>` child_node **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_debug_collisions_hint<class_SceneTree_set_debug_collisions_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_debug_navigation_hint<class_SceneTree_set_debug_navigation_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edited_scene_root<class_SceneTree_set_edited_scene_root>` **(** :ref:`Node<class_node>` scene **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_group<class_SceneTree_set_group>` **(** :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_group_flags<class_SceneTree_set_group_flags>` **(** :ref:`int<class_int>` call_flags, :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_input_as_handled<class_SceneTree_set_input_as_handled>` **(** **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_network_peer<class_SceneTree_set_network_peer>` **(** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` peer **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pause<class_SceneTree_set_pause>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_quit_on_go_back<class_SceneTree_set_quit_on_go_back>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_refuse_new_network_connections<class_SceneTree_set_refuse_new_network_connections>` **(** :ref:`bool<class_bool>` refuse **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_screen_stretch<class_SceneTree_set_screen_stretch>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize, :ref:`float<class_float>` shrink=1 **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_font_oversampling<class_SceneTree_set_use_font_oversampling>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -161,6 +129,46 @@ Signals
- **tree_changed** **(** **)**
Member Variables
----------------
.. _class_SceneTree_current_scene:
- :ref:`Node<class_node>` **current_scene**
.. _class_SceneTree_debug_collisions_hint:
- :ref:`bool<class_bool>` **debug_collisions_hint**
.. _class_SceneTree_debug_navigation_hint:
- :ref:`bool<class_bool>` **debug_navigation_hint**
.. _class_SceneTree_edited_scene_root:
- :ref:`Node<class_node>` **edited_scene_root**
.. _class_SceneTree_network_peer:
- :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **network_peer** - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()<class_SceneTree_is_network_server()>`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node<class_node>`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
.. _class_SceneTree_paused:
- :ref:`bool<class_bool>` **paused**
.. _class_SceneTree_refuse_new_network_connections:
- :ref:`bool<class_bool>` **refuse_new_network_connections**
.. _class_SceneTree_root:
- :ref:`Viewport<class_viewport>` **root**
.. _class_SceneTree_use_font_oversampling:
- :ref:`bool<class_bool>` **use_font_oversampling**
Enums
-----
@@ -215,14 +223,6 @@ Member Function Description
- :ref:`SceneTreeTimer<class_scenetreetimer>` **create_timer** **(** :ref:`float<class_float>` time_sec, :ref:`bool<class_bool>` pause_mode_process=true **)**
.. _class_SceneTree_get_current_scene:
- :ref:`Node<class_node>` **get_current_scene** **(** **)** const
.. _class_SceneTree_get_edited_scene_root:
- :ref:`Node<class_node>` **get_edited_scene_root** **(** **)** const
.. _class_SceneTree_get_frame:
- :ref:`int<class_int>` **get_frame** **(** **)** const
@@ -243,10 +243,6 @@ Member Function Description
- :ref:`Array<class_array>` **get_nodes_in_group** **(** :ref:`String<class_string>` group **)**
.. _class_SceneTree_get_root:
- :ref:`Viewport<class_viewport>` **get_root** **(** **)** const
.. _class_SceneTree_get_rpc_sender_id:
- :ref:`int<class_int>` **get_rpc_sender_id** **(** **)** const
@@ -261,14 +257,6 @@ Member Function Description
Returns true if there is a :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` set (with :ref:`SceneTree.set_network_peer<class_SceneTree_set_network_peer>`).
.. _class_SceneTree_is_debugging_collisions_hint:
- :ref:`bool<class_bool>` **is_debugging_collisions_hint** **(** **)** const
.. _class_SceneTree_is_debugging_navigation_hint:
- :ref:`bool<class_bool>` **is_debugging_navigation_hint** **(** **)** const
.. _class_SceneTree_is_input_handled:
- :ref:`bool<class_bool>` **is_input_handled** **(** **)**
@@ -279,18 +267,6 @@ Returns true if there is a :ref:`NetworkedMultiplayerPeer<class_networkedmultipl
Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` is in server mode (listening for connections).
.. _class_SceneTree_is_paused:
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
.. _class_SceneTree_is_refusing_new_network_connections:
- :ref:`bool<class_bool>` **is_refusing_new_network_connections** **(** **)** const
.. _class_SceneTree_is_using_font_oversampling:
- :ref:`bool<class_bool>` **is_using_font_oversampling** **(** **)** const
.. _class_SceneTree_notify_group:
- void **notify_group** **(** :ref:`String<class_string>` group, :ref:`int<class_int>` notification **)**
@@ -315,22 +291,6 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedm
- void **set_auto_accept_quit** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_SceneTree_set_current_scene:
- void **set_current_scene** **(** :ref:`Node<class_node>` child_node **)**
.. _class_SceneTree_set_debug_collisions_hint:
- void **set_debug_collisions_hint** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SceneTree_set_debug_navigation_hint:
- void **set_debug_navigation_hint** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SceneTree_set_edited_scene_root:
- void **set_edited_scene_root** **(** :ref:`Node<class_node>` scene **)**
.. _class_SceneTree_set_group:
- void **set_group** **(** :ref:`String<class_string>` group, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)**
@@ -343,30 +303,12 @@ Returns true if this SceneTree's :ref:`NetworkedMultiplayerPeer<class_networkedm
- void **set_input_as_handled** **(** **)**
.. _class_SceneTree_set_network_peer:
- void **set_network_peer** **(** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` peer **)**
Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()<class_SceneTree_is_network_server()>`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node<class_node>`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
.. _class_SceneTree_set_pause:
- void **set_pause** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SceneTree_set_quit_on_go_back:
- void **set_quit_on_go_back** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_SceneTree_set_refuse_new_network_connections:
- void **set_refuse_new_network_connections** **(** :ref:`bool<class_bool>` refuse **)**
.. _class_SceneTree_set_screen_stretch:
- void **set_screen_stretch** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` aspect, :ref:`Vector2<class_vector2>` minsize, :ref:`float<class_float>` shrink=1 **)**
.. _class_SceneTree_set_use_font_oversampling:
- void **set_use_font_oversampling** **(** :ref:`bool<class_bool>` enable **)**
classes/class_scenetreetimer.rst
+4 -17
View File
@@ -16,15 +16,6 @@ Brief Description
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_left<class_SceneTreeTimer_get_time_left>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`set_time_left<class_SceneTreeTimer_set_time_left>` **(** :ref:`float<class_float>` time **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
Signals
-------
@@ -33,15 +24,11 @@ Signals
- **timeout** **(** **)**
Member Function Description
---------------------------
Member Variables
----------------
.. _class_SceneTreeTimer_get_time_left:
.. _class_SceneTreeTimer_time_left:
- :ref:`float<class_float>` **get_time_left** **(** **)** const
.. _class_SceneTreeTimer_set_time_left:
- void **set_time_left** **(** :ref:`float<class_float>` time **)**
- :ref:`float<class_float>` **time_left**
classes/class_script.rst
+8 -16
View File
@@ -28,8 +28,6 @@ Member Functions
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_base_type<class_Script_get_instance_base_type>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_source_code<class_Script_get_source_code>` **(** **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_script_signal<class_Script_has_script_signal>` **(** :ref:`String<class_string>` signal_name **)** const |
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_source_code<class_Script_has_source_code>` **(** **)** const |
@@ -40,8 +38,14 @@ Member Functions
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`reload<class_Script_reload>` **(** :ref:`bool<class_bool>` keep_state=false **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_source_code<class_Script_set_source_code>` **(** :ref:`String<class_string>` source **)** |
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Script_source_code:
- :ref:`String<class_string>` **source_code** - The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically.
Description
-----------
@@ -67,12 +71,6 @@ Returns true if the script can be instanced.
- :ref:`String<class_string>` **get_instance_base_type** **(** **)** const
.. _class_Script_get_source_code:
- :ref:`String<class_string>` **get_source_code** **(** **)** const
Returns the script source code, or an empty string if source code is not available.
.. _class_Script_has_script_signal:
- :ref:`bool<class_bool>` **has_script_signal** **(** :ref:`String<class_string>` signal_name **)** const
@@ -103,10 +101,4 @@ Returns true if the script is a tool script. A tool script can run in the editor
Reloads the script's class implementation. Returns an error code.
.. _class_Script_set_source_code:
- void **set_source_code** **(** :ref:`String<class_string>` source **)**
Sets the script source code. Does not reload the class implementation.
classes/class_scrollcontainer.rst
+10 -43
View File
@@ -16,29 +16,24 @@ Brief Description
A helper node for displaying scrollable elements (e.g. lists).
Member Functions
----------------
+------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_h_scroll<class_ScrollContainer_get_h_scroll>` **(** **)** const |
+------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_v_scroll<class_ScrollContainer_get_v_scroll>` **(** **)** const |
+------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`set_h_scroll<class_ScrollContainer_set_h_scroll>` **(** :ref:`int<class_int>` val **)** |
+------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`set_v_scroll<class_ScrollContainer_set_v_scroll>` **(** :ref:`int<class_int>` val **)** |
+------------------------+-----------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_ScrollContainer_scroll_horizontal:
- :ref:`bool<class_bool>` **scroll_horizontal**
- :ref:`int<class_int>` **scroll_horizontal** - The current horizontal scroll value.
.. _class_ScrollContainer_scroll_horizontal_enabled:
- :ref:`bool<class_bool>` **scroll_horizontal_enabled** - If ``true``, enables horizontal scrolling.
.. _class_ScrollContainer_scroll_vertical:
- :ref:`bool<class_bool>` **scroll_vertical**
- :ref:`int<class_int>` **scroll_vertical** - The current horizontal scroll value.
.. _class_ScrollContainer_scroll_vertical_enabled:
- :ref:`bool<class_bool>` **scroll_vertical_enabled** - If ``true``, enables vertical scrolling.
Description
@@ -46,31 +41,3 @@ Description
A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (HScrollbar, :ref:`VScrollBar<class_vscrollbar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
Member Function Description
---------------------------
.. _class_ScrollContainer_get_h_scroll:
- :ref:`int<class_int>` **get_h_scroll** **(** **)** const
Return current horizontal scroll value.
.. _class_ScrollContainer_get_v_scroll:
- :ref:`int<class_int>` **get_v_scroll** **(** **)** const
Return current vertical scroll value.
.. _class_ScrollContainer_set_h_scroll:
- void **set_h_scroll** **(** :ref:`int<class_int>` val **)**
Set horizontal scroll value.
.. _class_ScrollContainer_set_v_scroll:
- void **set_v_scroll** **(** :ref:`int<class_int>` val **)**
Set vertical scroll value.
classes/class_shader.rst
+8 -12
View File
@@ -19,8 +19,6 @@ To be changed, ignore.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_code<class_Shader_get_code>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_default_texture_param<class_Shader_get_default_texture_param>` **(** :ref:`String<class_string>` param **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -28,11 +26,17 @@ Member Functions
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_param<class_Shader_has_param>` **(** :ref:`String<class_string>` name **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_code<class_Shader_set_code>` **(** :ref:`String<class_string>` code **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_texture_param<class_Shader_set_default_texture_param>` **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Shader_code:
- :ref:`String<class_string>` **code**
Enums
-----
@@ -53,10 +57,6 @@ To be changed, ignore.
Member Function Description
---------------------------
.. _class_Shader_get_code:
- :ref:`String<class_string>` **get_code** **(** **)** const
.. _class_Shader_get_default_texture_param:
- :ref:`Texture<class_texture>` **get_default_texture_param** **(** :ref:`String<class_string>` param **)** const
@@ -69,10 +69,6 @@ Member Function Description
- :ref:`bool<class_bool>` **has_param** **(** :ref:`String<class_string>` name **)** const
.. _class_Shader_set_code:
- void **set_code** **(** :ref:`String<class_string>` code **)**
.. _class_Shader_set_default_texture_param:
- void **set_default_texture_param** **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)**
classes/class_shadermaterial.rst
+8 -12
View File
@@ -19,31 +19,27 @@ Brief Description
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shader<class_shader>` | :ref:`get_shader<class_ShaderMaterial_get_shader>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_shader_param<class_ShaderMaterial_get_shader_param>` **(** :ref:`String<class_string>` param **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader<class_ShaderMaterial_set_shader>` **(** :ref:`Shader<class_shader>` shader **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader_param<class_ShaderMaterial_set_shader_param>` **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_ShaderMaterial_shader:
- :ref:`Shader<class_shader>` **shader**
Member Function Description
---------------------------
.. _class_ShaderMaterial_get_shader:
- :ref:`Shader<class_shader>` **get_shader** **(** **)** const
.. _class_ShaderMaterial_get_shader_param:
- :ref:`Variant<class_variant>` **get_shader_param** **(** :ref:`String<class_string>` param **)** const
.. _class_ShaderMaterial_set_shader:
- void **set_shader** **(** :ref:`Shader<class_shader>` shader **)**
.. _class_ShaderMaterial_set_shader_param:
- void **set_shader_param** **(** :ref:`String<class_string>` param, :ref:`Variant<class_variant>` value **)**
classes/class_spatial.rst
+65 -77
View File
@@ -21,71 +21,67 @@ Most basic 3D game object, parent of all 3D related nodes.
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpatialGizmo<class_spatialgizmo>` | :ref:`get_gizmo<class_Spatial_get_gizmo>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Spatial<class_spatial>` | :ref:`get_parent_spatial<class_Spatial_get_parent_spatial>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`get_world<class_Spatial_get_world>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_rotate<class_Spatial_global_rotate>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_scale<class_Spatial_global_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_translate<class_Spatial_global_translate>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_Spatial_hide>` **(** **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_Spatial_is_local_transform_notification_enabled>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_Spatial_is_set_as_toplevel>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_Spatial_is_transform_notification_enabled>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_Spatial_is_visible_in_tree>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`look_at<class_Spatial_look_at>` **(** :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`look_at_from_position<class_Spatial_look_at_from_position>` **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`orthonormalize<class_Spatial_orthonormalize>` **(** **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate<class_Spatial_rotate>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_object_local<class_Spatial_rotate_object_local>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_x<class_Spatial_rotate_x>` **(** :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_y<class_Spatial_rotate_y>` **(** :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_z<class_Spatial_rotate_z>` **(** :ref:`float<class_float>` angle **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`scale_object_local<class_Spatial_scale_object_local>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_Spatial_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gizmo<class_Spatial_set_gizmo>` **(** :ref:`SpatialGizmo<class_spatialgizmo>` gizmo **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_identity<class_Spatial_set_identity>` **(** **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ignore_transform_notification<class_Spatial_set_ignore_transform_notification>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_local_transform<class_Spatial_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_transform<class_Spatial_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_Spatial_show>` **(** **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`to_global<class_Spatial_to_global>` **(** :ref:`Vector3<class_vector3>` local_point **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`to_local<class_Spatial_to_local>` **(** :ref:`Vector3<class_vector3>` global_point **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`translate<class_Spatial_translate>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`translate_object_local<class_Spatial_translate_object_local>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_gizmo<class_Spatial_update_gizmo>` **(** **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Spatial<class_spatial>` | :ref:`get_parent_spatial<class_Spatial_get_parent_spatial>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World<class_world>` | :ref:`get_world<class_Spatial_get_world>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_rotate<class_Spatial_global_rotate>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_scale<class_Spatial_global_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`global_translate<class_Spatial_global_translate>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_Spatial_hide>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_Spatial_is_local_transform_notification_enabled>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_Spatial_is_set_as_toplevel>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_Spatial_is_transform_notification_enabled>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_Spatial_is_visible_in_tree>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`look_at<class_Spatial_look_at>` **(** :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`look_at_from_position<class_Spatial_look_at_from_position>` **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`orthonormalize<class_Spatial_orthonormalize>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate<class_Spatial_rotate>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_object_local<class_Spatial_rotate_object_local>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_x<class_Spatial_rotate_x>` **(** :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_y<class_Spatial_rotate_y>` **(** :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rotate_z<class_Spatial_rotate_z>` **(** :ref:`float<class_float>` angle **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`scale_object_local<class_Spatial_scale_object_local>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_Spatial_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_identity<class_Spatial_set_identity>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ignore_transform_notification<class_Spatial_set_ignore_transform_notification>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_local_transform<class_Spatial_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_notify_transform<class_Spatial_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_Spatial_show>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`to_global<class_Spatial_to_global>` **(** :ref:`Vector3<class_vector3>` local_point **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`to_local<class_Spatial_to_local>` **(** :ref:`Vector3<class_vector3>` global_point **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`translate<class_Spatial_translate>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`translate_object_local<class_Spatial_translate_object_local>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_gizmo<class_Spatial_update_gizmo>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -100,6 +96,10 @@ Emitted when node visibility changes.
Member Variables
----------------
.. _class_Spatial_gizmo:
- :ref:`SpatialGizmo<class_spatialgizmo>` **gizmo** - The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` as custom visualization and editing handles in Editor.
.. _class_Spatial_global_transform:
- :ref:`Transform<class_transform>` **global_transform** - World space (global) :ref:`Transform<class_transform>` of this node.
@@ -155,12 +155,6 @@ Affine operations (rotate, scale, translate) happen in parent's local coordinate
Member Function Description
---------------------------
.. _class_Spatial_get_gizmo:
- :ref:`SpatialGizmo<class_spatialgizmo>` **get_gizmo** **(** **)** const
Returns the SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` as custom visualization and editing handles in Editor.
.. _class_Spatial_get_parent_spatial:
- :ref:`Spatial<class_spatial>` **get_parent_spatial** **(** **)** const
@@ -279,12 +273,6 @@ Scales the local transformation by given 3D scale factors in object-local coordi
Makes the node ignore its parents transformations. Node transformations are only in global space.
.. _class_Spatial_set_gizmo:
- void **set_gizmo** **(** :ref:`SpatialGizmo<class_spatialgizmo>` gizmo **)**
Set :ref:`SpatialGizmo<class_spatialgizmo>` for this node. Used for example in :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` as custom visualization and editing handles in Editor.
.. _class_Spatial_set_identity:
- void **set_identity** **(** **)**
classes/class_spatialvelocitytracker.rst
+15 -19
View File
@@ -19,17 +19,21 @@ Brief Description
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_tracked_linear_velocity<class_SpatialVelocityTracker_get_tracked_linear_velocity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_tracking_physics_step<class_SpatialVelocityTracker_is_tracking_physics_step>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_SpatialVelocityTracker_reset>` **(** :ref:`Vector3<class_vector3>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_track_physics_step<class_SpatialVelocityTracker_set_track_physics_step>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_position<class_SpatialVelocityTracker_update_position>` **(** :ref:`Vector3<class_vector3>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_tracked_linear_velocity<class_SpatialVelocityTracker_get_tracked_linear_velocity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_SpatialVelocityTracker_reset>` **(** :ref:`Vector3<class_vector3>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_position<class_SpatialVelocityTracker_update_position>` **(** :ref:`Vector3<class_vector3>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_SpatialVelocityTracker_track_physics_step:
- :ref:`bool<class_bool>` **track_physics_step**
Member Function Description
---------------------------
@@ -38,18 +42,10 @@ Member Function Description
- :ref:`Vector3<class_vector3>` **get_tracked_linear_velocity** **(** **)** const
.. _class_SpatialVelocityTracker_is_tracking_physics_step:
- :ref:`bool<class_bool>` **is_tracking_physics_step** **(** **)** const
.. _class_SpatialVelocityTracker_reset:
- void **reset** **(** :ref:`Vector3<class_vector3>` position **)**
.. _class_SpatialVelocityTracker_set_track_physics_step:
- void **set_track_physics_step** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SpatialVelocityTracker_update_position:
- void **update_position** **(** :ref:`Vector3<class_vector3>` position **)**
classes/class_streampeer.rst
+8 -16
View File
@@ -54,8 +54,6 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_var<class_StreamPeer_get_var>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_big_endian_enabled<class_StreamPeer_is_big_endian_enabled>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_16<class_StreamPeer_put_16>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_32<class_StreamPeer_put_32>` **(** :ref:`int<class_int>` val **)** |
@@ -84,8 +82,14 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_var<class_StreamPeer_put_var>` **(** :ref:`Variant<class_variant>` val **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_big_endian<class_StreamPeer_set_big_endian>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_StreamPeer_big_endian:
- :ref:`bool<class_bool>` **big_endian** - If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding.
Description
-----------
@@ -191,12 +195,6 @@ Get a utf8 string with byte-length "bytes" from the stream (this decodes the str
Get a Variant from the stream.
.. _class_StreamPeer_is_big_endian_enabled:
- :ref:`bool<class_bool>` **is_big_endian_enabled** **(** **)** const
Return whether this ``StreamPeer`` is using big-endian format.
.. _class_StreamPeer_put_16:
- void **put_16** **(** :ref:`int<class_int>` val **)**
@@ -281,10 +279,4 @@ Put a zero-terminated utf8 string into the stream.
Put a Variant into the stream.
.. _class_StreamPeer_set_big_endian:
- void **set_big_endian** **(** :ref:`bool<class_bool>` enable **)**
Set this ``StreamPeer`` to use big-endian format. Default is false.
classes/class_streampeerbuffer.rst
+21 -25
View File
@@ -19,23 +19,27 @@ Brief Description
Member Functions
----------------
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_StreamPeerBuffer_clear>` **(** **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`StreamPeerBuffer<class_streampeerbuffer>` | :ref:`duplicate<class_StreamPeerBuffer_duplicate>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data_array<class_StreamPeerBuffer_get_data_array>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_get_position>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_get_size>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_StreamPeerBuffer_resize>` **(** :ref:`int<class_int>` size **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_StreamPeerBuffer_seek>` **(** :ref:`int<class_int>` position **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data_array<class_StreamPeerBuffer_set_data_array>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`clear<class_StreamPeerBuffer_clear>` **(** **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`StreamPeerBuffer<class_streampeerbuffer>` | :ref:`duplicate<class_StreamPeerBuffer_duplicate>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_get_position>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_get_size>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`resize<class_StreamPeerBuffer_resize>` **(** :ref:`int<class_int>` size **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`seek<class_StreamPeerBuffer_seek>` **(** :ref:`int<class_int>` position **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_StreamPeerBuffer_data_array:
- :ref:`PoolByteArray<class_poolbytearray>` **data_array**
Member Function Description
---------------------------
@@ -48,10 +52,6 @@ Member Function Description
- :ref:`StreamPeerBuffer<class_streampeerbuffer>` **duplicate** **(** **)** const
.. _class_StreamPeerBuffer_get_data_array:
- :ref:`PoolByteArray<class_poolbytearray>` **get_data_array** **(** **)** const
.. _class_StreamPeerBuffer_get_position:
- :ref:`int<class_int>` **get_position** **(** **)** const
@@ -68,8 +68,4 @@ Member Function Description
- void **seek** **(** :ref:`int<class_int>` position **)**
.. _class_StreamPeerBuffer_set_data_array:
- void **set_data_array** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
classes/class_styleboxline.rst
+4 -21
View File
@@ -16,15 +16,6 @@ Brief Description
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_grow<class_StyleBoxLine_get_grow>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------+
| void | :ref:`set_grow<class_StyleBoxLine_set_grow>` **(** :ref:`float<class_float>` grow **)** |
+----------------------------+-----------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -32,6 +23,10 @@ Member Variables
- :ref:`Color<class_color>` **color**
.. _class_StyleBoxLine_grow:
- :ref:`float<class_float>` **grow**
.. _class_StyleBoxLine_thickness:
- :ref:`int<class_int>` **thickness**
@@ -41,15 +36,3 @@ Member Variables
- :ref:`bool<class_bool>` **vertical**
Member Function Description
---------------------------
.. _class_StyleBoxLine_get_grow:
- :ref:`float<class_float>` **get_grow** **(** **)** const
.. _class_StyleBoxLine_set_grow:
- void **set_grow** **(** :ref:`float<class_float>` grow **)**
classes/class_tabs.rst
+4 -12
View File
@@ -26,8 +26,6 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_offset_buttons_visible<class_Tabs_get_offset_buttons_visible>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_align<class_Tabs_get_tab_align>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tab_count<class_Tabs_get_tab_count>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_tab_disabled<class_Tabs_get_tab_disabled>` **(** :ref:`int<class_int>` tab_idx **)** const |
@@ -44,8 +42,6 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tab<class_Tabs_remove_tab>` **(** :ref:`int<class_int>` tab_idx **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_align<class_Tabs_set_tab_align>` **(** :ref:`int<class_int>` align **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_disabled<class_Tabs_set_tab_disabled>` **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tab_icon<class_Tabs_set_tab_icon>` **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)** |
@@ -92,6 +88,10 @@ Member Variables
- :ref:`bool<class_bool>` **scrolling_enabled**
.. _class_Tabs_tab_align:
- :ref:`TabAlign<enum_tabs_tabalign>` **tab_align**
.. _class_Tabs_tab_close_display_policy:
- :ref:`CloseButtonDisplayPolicy<enum_tabs_closebuttondisplaypolicy>` **tab_close_display_policy**
@@ -139,10 +139,6 @@ Member Function Description
- :ref:`bool<class_bool>` **get_offset_buttons_visible** **(** **)** const
.. _class_Tabs_get_tab_align:
- :ref:`int<class_int>` **get_tab_align** **(** **)** const
.. _class_Tabs_get_tab_count:
- :ref:`int<class_int>` **get_tab_count** **(** **)** const
@@ -179,10 +175,6 @@ Rearrange tab.
- void **remove_tab** **(** :ref:`int<class_int>` tab_idx **)**
.. _class_Tabs_set_tab_align:
- void **set_tab_align** **(** :ref:`int<class_int>` align **)**
.. _class_Tabs_set_tab_disabled:
- void **set_tab_disabled** **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)**
classes/class_textedit.rst
+5 -17
View File
@@ -88,10 +88,6 @@ Member Functions
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_line_as_hidden<class_TextEdit_set_line_as_hidden>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max_chars<class_TextEdit_set_max_chars>` **(** :ref:`int<class_int>` amount **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_wrap<class_TextEdit_set_wrap>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`toggle_fold_line<class_TextEdit_toggle_fold_line>` **(** :ref:`int<class_int>` line **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`undo<class_TextEdit_undo>` **(** **)** |
@@ -196,7 +192,11 @@ If ``false`` the context menu disregards mouse location.
.. _class_TextEdit_v_scroll_speed:
- :ref:`float<class_float>` **v_scroll_speed**
- :ref:`float<class_float>` **v_scroll_speed** - If ``true``, enables text wrapping when it goes beyond he edge of what is visible.
.. _class_TextEdit_wrap_lines:
- :ref:`bool<class_bool>` **wrap_lines**
Enums
@@ -413,18 +413,6 @@ Select all the text.
- void **set_line_as_hidden** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**
.. _class_TextEdit_set_max_chars:
- void **set_max_chars** **(** :ref:`int<class_int>` amount **)**
Set the maximum amount of characters editable.
.. _class_TextEdit_set_wrap:
- void **set_wrap** **(** :ref:`bool<class_bool>` enable **)**
Enable text wrapping when it goes beyond he edge of what is visible.
.. _class_TextEdit_toggle_fold_line:
- void **toggle_fold_line** **(** :ref:`int<class_int>` line **)**
classes/class_texture.rst
+9 -17
View File
@@ -30,8 +30,6 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_data<class_Texture_get_data>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_flags<class_Texture_get_flags>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_Texture_get_height>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Texture_get_size>` **(** **)** const |
@@ -40,8 +38,14 @@ Member Functions
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_alpha<class_Texture_has_alpha>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flags<class_Texture_set_flags>` **(** :ref:`int<class_int>` flags **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Texture_flags:
- :ref:`int<class_int>` **flags** - The texture's flags.
Enums
-----
@@ -50,10 +54,10 @@ Enums
enum **Flags**
- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
- **FLAG_REPEAT** = **2** --- Repeats texture (instead of clamp to edge).
- **FLAG_FILTER** = **4** --- Magnifying filter, to enable smooth zooming in of the texture.
- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
- **FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
@@ -86,12 +90,6 @@ Member Function Description
- :ref:`Image<class_image>` **get_data** **(** **)** const
.. _class_Texture_get_flags:
- :ref:`int<class_int>` **get_flags** **(** **)** const
Return the current texture flags.
.. _class_Texture_get_height:
- :ref:`int<class_int>` **get_height** **(** **)** const
@@ -114,10 +112,4 @@ Return the texture width.
- :ref:`bool<class_bool>` **has_alpha** **(** **)** const
.. _class_Texture_set_flags:
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
Change the texture flags.
classes/class_timer.rst
+15 -31
View File
@@ -19,19 +19,13 @@ A countdown timer.
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_time_left<class_Timer_get_time_left>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_Timer_is_paused>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stopped<class_Timer_is_stopped>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------+
| void | :ref:`set_paused<class_Timer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
+----------------------------+--------------------------------------------------------------------------------------+
| void | :ref:`start<class_Timer_start>` **(** **)** |
+----------------------------+--------------------------------------------------------------------------------------+
| void | :ref:`stop<class_Timer_stop>` **(** **)** |
+----------------------------+--------------------------------------------------------------------------------------+
+--------------------------+-------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_stopped<class_Timer_is_stopped>` **(** **)** const |
+--------------------------+-------------------------------------------------------------+
| void | :ref:`start<class_Timer_start>` **(** **)** |
+--------------------------+-------------------------------------------------------------+
| void | :ref:`stop<class_Timer_stop>` **(** **)** |
+--------------------------+-------------------------------------------------------------+
Signals
-------
@@ -54,10 +48,18 @@ Member Variables
- :ref:`bool<class_bool>` **one_shot** - If ``true``, Timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``.
.. _class_Timer_paused:
- :ref:`bool<class_bool>` **paused** - If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start<class_Timer_start>` is called.
.. _class_Timer_process_mode:
- :ref:`TimerProcessMode<enum_timer_timerprocessmode>` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value.
.. _class_Timer_time_left:
- :ref:`float<class_float>` **time_left** - The timer's remaining time in seconds. Returns 0 if the timer is inactive.
.. _class_Timer_wait_time:
- :ref:`float<class_float>` **wait_time** - Wait time in seconds.
@@ -82,30 +84,12 @@ Counts down a specified interval and emits a signal on reaching 0. Can be set to
Member Function Description
---------------------------
.. _class_Timer_get_time_left:
- :ref:`float<class_float>` **get_time_left** **(** **)** const
Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive.
.. _class_Timer_is_paused:
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
Returns ``true`` if the timer is paused.
.. _class_Timer_is_stopped:
- :ref:`bool<class_bool>` **is_stopped** **(** **)** const
Returns ``true`` if the timer is stopped.
.. _class_Timer_set_paused:
- void **set_paused** **(** :ref:`bool<class_bool>` paused **)**
Pauses the timer. If ``paused`` is ``true``, the timer will not process until it is started or unpaused again, even if :ref:`start<class_Timer_start>` is called.
.. _class_Timer_start:
- void **start** **(** **)**
classes/class_tree.rst
+32 -96
View File
@@ -28,22 +28,14 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`ensure_cursor_is_visible<class_Tree_ensure_cursor_is_visible>` **(** **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_allow_reselect<class_Tree_get_allow_reselect>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_allow_rmb_select<class_Tree_get_allow_rmb_select>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_column_at_position<class_Tree_get_column_at_position>` **(** :ref:`Vector2<class_vector2>` position **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_column_title<class_Tree_get_column_title>` **(** :ref:`int<class_int>` column **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_column_width<class_Tree_get_column_width>` **(** :ref:`int<class_int>` column **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_columns<class_Tree_get_columns>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_custom_popup_rect<class_Tree_get_custom_popup_rect>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_drop_mode_flags<class_Tree_get_drop_mode_flags>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_drop_section_at_position<class_Tree_get_drop_section_at_position>` **(** :ref:`Vector2<class_vector2>` position **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_treeitem>` | :ref:`get_edited<class_Tree_get_edited>` **(** **)** const |
@@ -66,12 +58,6 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected_column<class_Tree_get_selected_column>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_folding_hidden<class_Tree_is_folding_hidden>` **(** **)** const |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_allow_reselect<class_Tree_set_allow_reselect>` **(** :ref:`bool<class_bool>` allow **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_allow_rmb_select<class_Tree_set_allow_rmb_select>` **(** :ref:`bool<class_bool>` allow **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_column_expand<class_Tree_set_column_expand>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_column_min_width<class_Tree_set_column_min_width>` **(** :ref:`int<class_int>` column, :ref:`int<class_int>` min_width **)** |
@@ -80,16 +66,6 @@ Member Functions
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_column_titles_visible<class_Tree_set_column_titles_visible>` **(** :ref:`bool<class_bool>` visible **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_columns<class_Tree_set_columns>` **(** :ref:`int<class_int>` amount **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drop_mode_flags<class_Tree_set_drop_mode_flags>` **(** :ref:`int<class_int>` flags **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_folding<class_Tree_set_hide_folding>` **(** :ref:`bool<class_bool>` hide **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_root<class_Tree_set_hide_root>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_select_mode<class_Tree_set_select_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -181,6 +157,38 @@ Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``.
- **nothing_selected** **(** **)**
Member Variables
----------------
.. _class_Tree_allow_reselect:
- :ref:`bool<class_bool>` **allow_reselect** - If ``true`` the currently selected cell may be selected again.
.. _class_Tree_allow_rmb_select:
- :ref:`bool<class_bool>` **allow_rmb_select** - If ``true`` a right mouse button click can select items.
.. _class_Tree_columns:
- :ref:`int<class_int>` **columns** - The amount of columns.
.. _class_Tree_drop_mode_flags:
- :ref:`int<class_int>` **drop_mode_flags** - The drop mode as an OR combination of flags. See ``DROP_MODE\_\*`` constants.
.. _class_Tree_hide_folding:
- :ref:`bool<class_bool>` **hide_folding** - If ``true`` the folding arrow is hidden.
.. _class_Tree_hide_root:
- :ref:`bool<class_bool>` **hide_root** - If ``true`` the tree's root is hidden.
.. _class_Tree_select_mode:
- :ref:`SelectMode<enum_tree_selectmode>` **select_mode** - Allow single or multiple selection. See the ``SELECT\_\*`` constants.
Enums
-----
@@ -246,18 +254,6 @@ Create an item in the tree and add it as the last child of ``parent``. If parent
Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible.
.. _class_Tree_get_allow_reselect:
- :ref:`bool<class_bool>` **get_allow_reselect** **(** **)** const
Returns ``true`` if a cell that is currently already selected may be selected again.
.. _class_Tree_get_allow_rmb_select:
- :ref:`bool<class_bool>` **get_allow_rmb_select** **(** **)** const
Returns ``true`` if a right click can select items.
.. _class_Tree_get_column_at_position:
- :ref:`int<class_int>` **get_column_at_position** **(** :ref:`Vector2<class_vector2>` position **)** const
@@ -276,24 +272,12 @@ Returns the column's title.
Returns the column's width in pixels.
.. _class_Tree_get_columns:
- :ref:`int<class_int>` **get_columns** **(** **)** const
Returns the amount of columns.
.. _class_Tree_get_custom_popup_rect:
- :ref:`Rect2<class_rect2>` **get_custom_popup_rect** **(** **)** const
Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode<class_TreeItem_set_cell_mode>`.
.. _class_Tree_get_drop_mode_flags:
- :ref:`int<class_int>` **get_drop_mode_flags** **(** **)** const
Returns the current drop mode's flags.
.. _class_Tree_get_drop_section_at_position:
- :ref:`int<class_int>` **get_drop_section_at_position** **(** :ref:`Vector2<class_vector2>` position **)** const
@@ -358,24 +342,6 @@ Returns the currently selected item.
Returns the current selection's column.
.. _class_Tree_is_folding_hidden:
- :ref:`bool<class_bool>` **is_folding_hidden** **(** **)** const
Returns ``true`` if the folding arrow is hidden.
.. _class_Tree_set_allow_reselect:
- void **set_allow_reselect** **(** :ref:`bool<class_bool>` allow **)**
If ``true`` the currently selected cell may be selected again.
.. _class_Tree_set_allow_rmb_select:
- void **set_allow_rmb_select** **(** :ref:`bool<class_bool>` allow **)**
If ``true`` a right mouse button click can select items.
.. _class_Tree_set_column_expand:
- void **set_column_expand** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` expand **)**
@@ -400,34 +366,4 @@ Set the title of a column.
If ``true`` column titles are visible.
.. _class_Tree_set_columns:
- void **set_columns** **(** :ref:`int<class_int>` amount **)**
Set the amount of columns.
.. _class_Tree_set_drop_mode_flags:
- void **set_drop_mode_flags** **(** :ref:`int<class_int>` flags **)**
Set the drop mode as an OR combination of flags. See ``DROP_MODE\_\*`` constants.
.. _class_Tree_set_hide_folding:
- void **set_hide_folding** **(** :ref:`bool<class_bool>` hide **)**
If ``true`` the folding arrow is hidden.
.. _class_Tree_set_hide_root:
- void **set_hide_root** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` the tree's root is hidden.
.. _class_Tree_set_select_mode:
- void **set_select_mode** **(** :ref:`int<class_int>` mode **)**
Allow single or multiple selection. See the ``SELECT\_\*`` constants.
classes/class_treeitem.rst
+16 -48
View File
@@ -40,8 +40,6 @@ Member Functions
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_custom_bg_color<class_TreeItem_get_custom_bg_color>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_custom_minimum_height<class_TreeItem_get_custom_minimum_height>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_expand_right<class_TreeItem_get_expand_right>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_TreeItem_get_icon>` **(** :ref:`int<class_int>` column **)** const |
@@ -76,14 +74,10 @@ Member Functions
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_checked<class_TreeItem_is_checked>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_collapsed<class_TreeItem_is_collapsed>` **(** **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_custom_set_as_button<class_TreeItem_is_custom_set_as_button>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editable<class_TreeItem_is_editable>` **(** :ref:`int<class_int>` column **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_folding_disabled<class_TreeItem_is_folding_disabled>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selectable<class_TreeItem_is_selectable>` **(** :ref:`int<class_int>` column **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_selected<class_TreeItem_is_selected>` **(** :ref:`int<class_int>` column **)** |
@@ -102,8 +96,6 @@ Member Functions
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_checked<class_TreeItem_set_checked>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` checked **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collapsed<class_TreeItem_set_collapsed>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_as_button<class_TreeItem_set_custom_as_button>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_bg_color<class_TreeItem_set_custom_bg_color>` **(** :ref:`int<class_int>` column, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` just_outline=false **)** |
@@ -112,10 +104,6 @@ Member Functions
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_draw<class_TreeItem_set_custom_draw>` **(** :ref:`int<class_int>` column, :ref:`Object<class_object>` object, :ref:`String<class_string>` callback **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_minimum_height<class_TreeItem_set_custom_minimum_height>` **(** :ref:`int<class_int>` height **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disable_folding<class_TreeItem_set_disable_folding>` **(** :ref:`bool<class_bool>` disable **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_editable<class_TreeItem_set_editable>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_expand_right<class_TreeItem_set_expand_right>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)** |
@@ -141,6 +129,22 @@ Member Functions
| void | :ref:`set_tooltip<class_TreeItem_set_tooltip>` **(** :ref:`int<class_int>` column, :ref:`String<class_string>` tooltip **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_TreeItem_collapsed:
- :ref:`bool<class_bool>` **collapsed** - If ``true`` the TreeItem is collapsed.
.. _class_TreeItem_custom_minimum_height:
- :ref:`int<class_int>` **custom_minimum_height** - The custom minimum height.
.. _class_TreeItem_disable_folding:
- :ref:`bool<class_bool>` **disable_folding** - If ``true`` folding is disabled for this TreeItem.
Enums
-----
@@ -232,12 +236,6 @@ Returns the TreeItem's child items.
Returns the custom background color of column ``column``.
.. _class_TreeItem_get_custom_minimum_height:
- :ref:`int<class_int>` **get_custom_minimum_height** **(** **)** const
Returns the custom minimum height.
.. _class_TreeItem_get_expand_right:
- :ref:`bool<class_bool>` **get_expand_right** **(** :ref:`int<class_int>` column **)** const
@@ -334,12 +332,6 @@ Returns ``true`` if the button at index ``button_idx`` for the given column is d
Returns ``true`` if the given column is checked.
.. _class_TreeItem_is_collapsed:
- :ref:`bool<class_bool>` **is_collapsed** **(** **)**
Returns ``true`` if this TreeItem is collapsed.
.. _class_TreeItem_is_custom_set_as_button:
- :ref:`bool<class_bool>` **is_custom_set_as_button** **(** :ref:`int<class_int>` column **)** const
@@ -350,12 +342,6 @@ Returns ``true`` if this TreeItem is collapsed.
Returns ``true`` if column ``column`` is editable.
.. _class_TreeItem_is_folding_disabled:
- :ref:`bool<class_bool>` **is_folding_disabled** **(** **)** const
Returns ``true`` if folding is disabled for this TreeItem.
.. _class_TreeItem_is_selectable:
- :ref:`bool<class_bool>` **is_selectable** **(** :ref:`int<class_int>` column **)** const
@@ -410,12 +396,6 @@ Sets the given column's cell mode to ``mode``. See ``CELL_MODE\_\*`` constants.
If ``true`` the column ``column`` is checked.
.. _class_TreeItem_set_collapsed:
- void **set_collapsed** **(** :ref:`bool<class_bool>` enable **)**
If ``true`` the TreeItem is collapsed.
.. _class_TreeItem_set_custom_as_button:
- void **set_custom_as_button** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enable **)**
@@ -438,18 +418,6 @@ Sets the given column's custom color.
Sets the given column's custom draw callback to ``callback`` method on ``object``.
.. _class_TreeItem_set_custom_minimum_height:
- void **set_custom_minimum_height** **(** :ref:`int<class_int>` height **)**
Sets the custom minimum height of this TreeItem.
.. _class_TreeItem_set_disable_folding:
- void **set_disable_folding** **(** :ref:`bool<class_bool>` disable **)**
If ``true`` folding is disabled for this TreeItem.
.. _class_TreeItem_set_editable:
- void **set_editable** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` enabled **)**
classes/class_tween.rst
+8 -32
View File
@@ -26,8 +26,6 @@ Member Functions
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_runtime<class_Tween_get_runtime>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_Tween_get_speed_scale>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interpolate_callback<class_Tween_interpolate_callback>` **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interpolate_deferred_callback<class_Tween_interpolate_deferred_callback>` **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)** |
@@ -38,8 +36,6 @@ Member Functions
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_Tween_is_active>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_repeat<class_Tween_is_repeat>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`remove<class_Tween_remove>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`remove_all<class_Tween_remove_all>` **(** **)** |
@@ -56,10 +52,6 @@ Member Functions
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_Tween_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_repeat<class_Tween_set_repeat>` **(** :ref:`bool<class_bool>` repeat **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed_scale<class_Tween_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`start<class_Tween_start>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stop<class_Tween_stop>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)** |
@@ -102,6 +94,14 @@ Member Variables
- :ref:`TweenProcessMode<enum_tween_tweenprocessmode>` **playback_process_mode**
.. _class_Tween_playback_speed:
- :ref:`float<class_float>` **playback_speed** - The speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using :ref:`set_active<class_Tween_set_active>` or :ref:`stop_all<class_Tween_stop_all>` and :ref:`resume_all<class_Tween_resume_all>` for this.
.. _class_Tween_repeat:
- :ref:`bool<class_bool>` **repeat** - If ``true``, the tween will repeat.
Enums
-----
@@ -181,12 +181,6 @@ Follow ``property`` of ``object`` and apply it on ``target_property`` of ``targe
Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished.
.. _class_Tween_get_speed_scale:
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
Returns the speed that has been set from editor GUI or :ref:`set_repeat<class_Tween_set_repeat>`.
.. _class_Tween_interpolate_callback:
- :ref:`bool<class_bool>` **interpolate_callback** **(** :ref:`Object<class_object>` object, :ref:`float<class_float>` duration, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` arg1=null, :ref:`Variant<class_variant>` arg2=null, :ref:`Variant<class_variant>` arg3=null, :ref:`Variant<class_variant>` arg4=null, :ref:`Variant<class_variant>` arg5=null **)**
@@ -221,12 +215,6 @@ Animate ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``d
Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended.
.. _class_Tween_is_repeat:
- :ref:`bool<class_bool>` **is_repeat** **(** **)** const
Returns true if repeat has been set from editor GUI or :ref:`set_repeat<class_Tween_set_repeat>`.
.. _class_Tween_remove:
- :ref:`bool<class_bool>` **remove** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` key="" **)**
@@ -275,18 +263,6 @@ Seek the animation to the given ``time`` in seconds.
Activate/deactivate the tween. You can use this for pausing animations, though :ref:`stop_all<class_Tween_stop_all>` and :ref:`resume_all<class_Tween_resume_all>` might be more fit for this.
.. _class_Tween_set_repeat:
- void **set_repeat** **(** :ref:`bool<class_bool>` repeat **)**
Make the tween repeat after all tweens have finished.
.. _class_Tween_set_speed_scale:
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using :ref:`set_active<class_Tween_set_active>` or :ref:`stop_all<class_Tween_stop_all>` and :ref:`resume_all<class_Tween_resume_all>` for this.
.. _class_Tween_start:
- :ref:`bool<class_bool>` **start** **(** **)**
classes/class_videoplayer.rst
+23 -59
View File
@@ -19,29 +19,17 @@ Control to play video files.
Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_buffering_msec<class_VideoPlayer_get_buffering_msec>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_VideoPlayer_get_stream_name>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stream_position<class_VideoPlayer_get_stream_position>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_video_texture<class_VideoPlayer_get_video_texture>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume<class_VideoPlayer_get_volume>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_VideoPlayer_is_playing>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_VideoPlayer_play>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_buffering_msec<class_VideoPlayer_set_buffering_msec>` **(** :ref:`int<class_int>` msec **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream_position<class_VideoPlayer_set_stream_position>` **(** :ref:`float<class_float>` position **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume<class_VideoPlayer_set_volume>` **(** :ref:`float<class_float>` volume **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_VideoPlayer_stop>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_VideoPlayer_get_stream_name>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_video_texture<class_VideoPlayer_get_video_texture>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_VideoPlayer_is_playing>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------+
| void | :ref:`play<class_VideoPlayer_play>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------+
| void | :ref:`stop<class_VideoPlayer_stop>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------+
Member Variables
----------------
@@ -54,6 +42,10 @@ Member Variables
- :ref:`bool<class_bool>` **autoplay**
.. _class_VideoPlayer_buffering_msec:
- :ref:`int<class_int>` **buffering_msec** - The amount of milliseconds to store in buffer while playing.
.. _class_VideoPlayer_bus:
- :ref:`String<class_string>` **bus**
@@ -70,6 +62,14 @@ Member Variables
- :ref:`VideoStream<class_videostream>` **stream**
.. _class_VideoPlayer_stream_position:
- :ref:`float<class_float>` **stream_position** - The current position of the stream, in seconds.
.. _class_VideoPlayer_volume:
- :ref:`float<class_float>` **volume** - The volume of the audio track as a linear value.
.. _class_VideoPlayer_volume_db:
- :ref:`float<class_float>` **volume_db**
@@ -83,36 +83,18 @@ This control has the ability to play video streams. The only format accepted is
Member Function Description
---------------------------
.. _class_VideoPlayer_get_buffering_msec:
- :ref:`int<class_int>` **get_buffering_msec** **(** **)** const
Get the amount of milliseconds to store in buffer while playing.
.. _class_VideoPlayer_get_stream_name:
- :ref:`String<class_string>` **get_stream_name** **(** **)** const
Get the name of the video stream.
.. _class_VideoPlayer_get_stream_position:
- :ref:`float<class_float>` **get_stream_position** **(** **)** const
Get the current position of the stream, in seconds.
.. _class_VideoPlayer_get_video_texture:
- :ref:`Texture<class_texture>` **get_video_texture** **(** **)**
Get the current frame of the video as a :ref:`Texture<class_texture>`.
.. _class_VideoPlayer_get_volume:
- :ref:`float<class_float>` **get_volume** **(** **)** const
Get the volume of the audio track as a linear value.
.. _class_VideoPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
@@ -125,24 +107,6 @@ Get whether or not the video is playing.
Start the video playback.
.. _class_VideoPlayer_set_buffering_msec:
- void **set_buffering_msec** **(** :ref:`int<class_int>` msec **)**
Set the amount of milliseconds to buffer during playback.
.. _class_VideoPlayer_set_stream_position:
- void **set_stream_position** **(** :ref:`float<class_float>` position **)**
Set the current position of the stream, in seconds.
.. _class_VideoPlayer_set_volume:
- void **set_volume** **(** :ref:`float<class_float>` volume **)**
Set the audio volume as a linear value.
.. _class_VideoPlayer_stop:
- void **stop** **(** **)**
classes/class_viewport.rst
+12 -46
View File
@@ -26,12 +26,8 @@ Member Functions
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Camera<class_camera>` | :ref:`get_camera<class_Viewport_get_camera>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_canvas_transform<class_Viewport_get_canvas_transform>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_final_transform<class_Viewport_get_final_transform>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_canvas_transform<class_Viewport_get_global_canvas_transform>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_position<class_Viewport_get_mouse_position>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_render_info<class_Viewport_get_render_info>` **(** :ref:`int<class_int>` info **)** |
@@ -44,8 +40,6 @@ Member Functions
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_visible_rect<class_Viewport_get_visible_rect>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_Viewport_get_world_2d>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`gui_get_drag_data<class_Viewport_gui_get_drag_data>` **(** **)** const |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>` **(** **)** const |
@@ -58,16 +52,10 @@ Member Functions
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_attach_to_screen_rect<class_Viewport_set_attach_to_screen_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_canvas_transform<class_Viewport_set_canvas_transform>` **(** :ref:`Transform2D<class_transform2d>` xform **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_global_canvas_transform<class_Viewport_set_global_canvas_transform>` **(** :ref:`Transform2D<class_transform2d>` xform **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_Viewport_set_size_override>` **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2( -1, -1 ), :ref:`Vector2<class_vector2>` margin=Vector2( 0, 0 ) **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override_stretch<class_Viewport_set_size_override_stretch>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_world_2d<class_Viewport_set_world_2d>` **(** :ref:`World2D<class_world2d>` world_2d **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unhandled_input<class_Viewport_unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` local_event **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_worlds<class_Viewport_update_worlds>` **(** **)** |
@@ -100,6 +88,10 @@ Member Variables
- :ref:`bool<class_bool>` **audio_listener_enable_3d**
.. _class_Viewport_canvas_transform:
- :ref:`Transform2D<class_transform2d>` **canvas_transform** - The canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem<class_canvasitem>`\ s. This is relative to the global canvas transform of the viewport.
.. _class_Viewport_debug_draw:
- :ref:`DebugDraw<enum_viewport_debugdraw>` **debug_draw**
@@ -108,6 +100,10 @@ Member Variables
- :ref:`bool<class_bool>` **disable_3d**
.. _class_Viewport_global_canvas_transform:
- :ref:`Transform2D<class_transform2d>` **global_canvas_transform** - The global canvas transform of the viewport. The canvas transform is relative to this.
.. _class_Viewport_gui_disable_input:
- :ref:`bool<class_bool>` **gui_disable_input**
@@ -180,6 +176,10 @@ Member Variables
- :ref:`World<class_world>` **world**
.. _class_Viewport_world_2d:
- :ref:`World2D<class_world2d>` **world_2d**
Enums
-----
@@ -291,24 +291,12 @@ Return the 2D world of the viewport.
Return the active 3D camera.
.. _class_Viewport_get_canvas_transform:
- :ref:`Transform2D<class_transform2d>` **get_canvas_transform** **(** **)** const
Get the canvas transform of the viewport.
.. _class_Viewport_get_final_transform:
- :ref:`Transform2D<class_transform2d>` **get_final_transform** **(** **)** const
Get the total transform of the viewport.
.. _class_Viewport_get_global_canvas_transform:
- :ref:`Transform2D<class_transform2d>` **get_global_canvas_transform** **(** **)** const
Get the global canvas transform of the viewport.
.. _class_Viewport_get_mouse_position:
- :ref:`Vector2<class_vector2>` **get_mouse_position** **(** **)** const
@@ -343,12 +331,6 @@ Get the viewport RID from the :ref:`VisualServer<class_visualserver>`.
Return the final, visible rect in global screen coordinates.
.. _class_Viewport_get_world_2d:
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
Return the 2D world of the viewport.
.. _class_Viewport_gui_get_drag_data:
- :ref:`Variant<class_variant>` **gui_get_drag_data** **(** **)** const
@@ -381,18 +363,6 @@ Get the enabled status of the size strech override set with :ref:`set_size_overr
- void **set_attach_to_screen_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
.. _class_Viewport_set_canvas_transform:
- void **set_canvas_transform** **(** :ref:`Transform2D<class_transform2d>` xform **)**
Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem<class_canvasitem>`\ s. This is relative to the global canvas transform of the viewport.
.. _class_Viewport_set_global_canvas_transform:
- void **set_global_canvas_transform** **(** :ref:`Transform2D<class_transform2d>` xform **)**
Set the global canvas transform of the viewport. The canvas transform is relative to this.
.. _class_Viewport_set_size_override:
- void **set_size_override** **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2( -1, -1 ), :ref:`Vector2<class_vector2>` margin=Vector2( 0, 0 ) **)**
@@ -405,10 +375,6 @@ Set the size override of the viewport. If the enable parameter is true, it would
Set whether the size override affects stretch as well.
.. _class_Viewport_set_world_2d:
- void **set_world_2d** **(** :ref:`World2D<class_world2d>` world_2d **)**
.. _class_Viewport_unhandled_input:
- void **unhandled_input** **(** :ref:`InputEvent<class_inputevent>` local_event **)**
classes/class_visualscriptyield.rst
+4 -21
View File
@@ -16,18 +16,13 @@ Brief Description
Member Functions
----------------
+------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_yield_mode<class_VisualScriptYield_get_yield_mode>` **(** **)** |
+------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`set_yield_mode<class_VisualScriptYield_set_yield_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------+------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_VisualScriptYield_mode:
- :ref:`YieldMode<enum_visualscriptyield_yieldmode>` **mode**
.. _class_VisualScriptYield_wait_time:
- :ref:`float<class_float>` **wait_time**
@@ -45,15 +40,3 @@ enum **YieldMode**
- **YIELD_WAIT** = **3**
Member Function Description
---------------------------
.. _class_VisualScriptYield_get_yield_mode:
- :ref:`int<class_int>` **get_yield_mode** **(** **)**
.. _class_VisualScriptYield_set_yield_mode:
- void **set_yield_mode** **(** :ref:`int<class_int>` mode **)**
classes/class_world.rst
+12 -33
View File
@@ -16,20 +16,13 @@ Brief Description
Class that has everything pertaining to a world.
Member Functions
----------------
+----------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` | :ref:`get_direct_space_state<class_World_get_direct_space_state>` **(** **)** |
+----------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_scenario<class_World_get_scenario>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_space<class_World_get_space>` **(** **)** const |
+----------------------------------------------------------------+-------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_World_direct_space_state:
- :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **direct_space_state** - The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``.
.. _class_World_environment:
- :ref:`Environment<class_environment>` **environment** - The World's :ref:`Environment<class_environment>`.
@@ -38,31 +31,17 @@ Member Variables
- :ref:`Environment<class_environment>` **fallback_environment** - The World's fallback_environment will be used if the World's :ref:`Environment<class_environment>` fails or is missing.
.. _class_World_scenario:
- :ref:`RID<class_rid>` **scenario** - The World's visual scenario.
.. _class_World_space:
- :ref:`RID<class_rid>` **space** - The World's physics space.
Description
-----------
Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world.
Member Function Description
---------------------------
.. _class_World_get_direct_space_state:
- :ref:`PhysicsDirectSpaceState<class_physicsdirectspacestate>` **get_direct_space_state** **(** **)**
Returns the World's physics space.
.. _class_World_get_scenario:
- :ref:`RID<class_rid>` **get_scenario** **(** **)** const
Returns the World's visual scenario.
.. _class_World_get_space:
- :ref:`RID<class_rid>` **get_space** **(** **)** const
Returns the World's sound space.
classes/class_world2d.rst
+13 -30
View File
@@ -16,41 +16,24 @@ Brief Description
Class that has everything pertaining to a 2D world.
Member Functions
Member Variables
----------------
+--------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_World2D_get_canvas>` **(** **)** |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` | :ref:`get_direct_space_state<class_World2D_get_direct_space_state>` **(** **)** |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_space<class_World2D_get_space>` **(** **)** |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------+
.. _class_World2D_canvas:
- :ref:`RID<class_rid>` **canvas** - The :ref:`RID<class_rid>` of this world's canvas resource. Used by the :ref:`VisualServer<class_visualserver>` for 2D drawing.
.. _class_World2D_direct_space_state:
- :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` **direct_space_state** - The state of this world's physics space. This allows arbitrary querying for collision.
.. _class_World2D_space:
- :ref:`RID<class_rid>` **space** - The :ref:`RID<class_rid>` of this world's physics space resource. Used by the :ref:`Physics2DServer<class_physics2dserver>` for 2D physics, treating it as both a space and an area.
Description
-----------
Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world.
Member Function Description
---------------------------
.. _class_World2D_get_canvas:
- :ref:`RID<class_rid>` **get_canvas** **(** **)**
Retrieve the :ref:`RID<class_rid>` of this world's canvas resource. Used by the :ref:`VisualServer<class_visualserver>` for 2D drawing.
.. _class_World2D_get_direct_space_state:
- :ref:`Physics2DDirectSpaceState<class_physics2ddirectspacestate>` **get_direct_space_state** **(** **)**
Retrieve the state of this world's physics space. This allows arbitrary querying for collision.
.. _class_World2D_get_space:
- :ref:`RID<class_rid>` **get_space** **(** **)**
Retrieve the :ref:`RID<class_rid>` of this world's physics space resource. Used by the :ref:`Physics2DServer<class_physics2dserver>` for 2D physics, treating it as both a space and an area.